yapi平台基本使用介绍

Posted 2023-03-09

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了yapi平台基本使用介绍相关的知识，希望对你有一定的参考价值。

参考技术A 展示分组内自己所在的项目，点击进入项目详情

展示和管理分组内的人员构成

1.添加成员
2.更改成员权限
3.删除成员

展示分组内的项目接口动态

自定义分组信息

添加分类，生成新的接口集合
在分类中添加接口，新增简单接口信息

点击某个接口，进入接口详情--预览

展示详细的接口信息，包括基本信息，请求参数，返回数据等

点击顶部“编辑”，进入编辑模式

接口的基本信息及路径
接口url中有参数的，可以用标识

1.参数类型可以选择 body，query以及headers
2.body参数可以选择对应类型
3.选择form格式可以批量添加参数
4.选择json格式可以直接导入，系统会进行格式校验，通过后会自动解析并填充在下方

1.返回数据为接口期望的返回结果，也可以已json格式或者raw格式填写
2.选择json格式可以直接导入，系统会进行格式校验，通过后会自动解析并填充在下方

发送--请求此接口
保存--将此接口及请求数据保存至测试合集

可以自定义接口返回，设置过滤条件，满足过滤条件时，请求的接口返回则为自定义的返回

此处设置一个期望，打开postman，请求对应的mock地址
参数满足过滤条件，则请求返回为自定义结果

后续更新自动化实施详细讲解

api更新修改后，此处可以查看修改记录及修改内容
点击改动详情，可查看接口的具体改动内容。红色表示删除的内容，绿色表示新增的内容。

点击弹出下拉框，可选择自己需要的模式
导入成功后，导入的接口会在接口列表中展示

可将平台中已有的接口数据导出，导出后的文件可以作为数据源再次在其他项目导入。
可以解决项目迁移的问题

对项目所属成员进行增加，删除，修改权限等操作

项目基本信息

1、项目环境管理，可以配置多个不同的环境，在测试接口或者进行自动化测试时可以按需选择对应的环境
2、环境可以增加，可以删除
3、每个环境可以单独设置域名，请求头，全局变量等个性化数据，以满足测试的多样性

可以自定义脚本，分为请求前和请求后的处理。请求前处理脚本，会在接口请求开始前执行，请求后处理脚本，会在请求完成后执行

生成唯一项目标识，可以作为请求yapi项目openapi的凭证
非可视化界面操作，yapi提供了部分常用的openapi。
如：进行自动化测试，定期进行接口同步，进行数据导入等等

可以选择时间，选择周期，选择同步方式，定期自动执行接口同步，保证yapi平台中接口为最新接口，不需要人工维护

无特殊功能，可以作为一个记事本，记录项目关联信息

docker搭建yapi接口文档系统Idea中上传接口在线调用

一、前言

在我们后端开发中，必不可少的是接口的交接，有很多种方式，常见的就是swagger，不过这个侵入性太强了。还有就是接口文档的框架，比如今天小编带大家一起搭建的yapi，在公司还是挺常见的！今天小编就大家从搭建到使用，详细的教学一波哈！！

二、介绍

1. 平台介绍

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

2. 特性

基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回- - 期望数据
支持 postman, har, swagger 数据导入
免费开源，内网部署，信息再也不怕泄露了

3. 环境支持

nodejs（7.6+)
mongodb（2.6+）
git

在docker中只需要搭建一下mongo，用来数据的存储即可！

三、运行mongo

0. 创建网络

docker network create yapi

1. 创建挂载文件

mkdir -p /data/mongo

2. 运行mongo

docker run -d \\
  --name mongodb \\
  --restart always \\
  --net=yapi \\
  -p 27017:27017 \\
  -v /data/mongo:/data/db \\
  -e MONGO_INITDB_DATABASE=yapi \\
  -e MONGO_INITDB_ROOT_USERNAME=yapi \\
  -e MONGO_INITDB_ROOT_PASSWORD=yapi \\
  mongo

3. 进入容器初始化数据库

进入 MongoDB 容器，从上图查看 MongoDB 容器可以获取到容器 id，以下示例使用 50f1f6c50139代表 MongoDB 的容器 id，只需要简写即可！

docker exec -it 50 /bin/bash

接着输入：

mongosh

==新版本需要加上sh，不然无法进入！==

use admin;
db.auth("yapi", "yapi");
# 创建 yapi 数据库
use yapi;
# 创建给 yapi 使用的账号和密码，限制权限
db.createUser(
  user: yapi,
  pwd: yapi,
  roles: [
  role: "dbAdmin", db: "yapi" ,
  role: "readWrite", db: "yapi" 
  ]
);
# 退出 Mongo Cli
exit
# 退出容器
Ctrl+P+Q

四、运行yapi

1. 搭建挂载配置文件

mkdir -p /data/yapi

vim config.json


   "port": "3000",
   "adminAccount": "wangzhenjun1221@163.com",
   "timeout":120000,
   "db": 
     "servername": "mongo",
     "DATABASE": "yapi",
     "port": 27017,
     "user": "yapi",
     "pass": "yapi",
     "authSource": ""
   ,
   "mail": 
     "enable": true,
     "host": "smtp.gmail.com",
     "port": 465,
     "from": "*",
     "auth": 
       "user": "wangzhenjun1221@163.com",
       "pass": "xxx"

:wq退出

2. 初始化数据库表

docker run -d --rm \\
  --name yapi-init \\
  --link mongodb:mongo \\
  --net=yapi \\
  -v /data/yapi/config.json:/yapi/config.json \\
   yapipro/yapi \\
  server/install.js

3. 测试连接mongo

我们使用Navicat进行可视化的连接数据库输入：admin 用户名密码都是刚刚配置的：yapi

连接成功！！

4. 运行yapi

docker run -d \\
   --name yapi \\
   --link mongodb:mongo \\
   --restart always \\
   --net=yapi \\
   -p 3000:3000 \\
   -v /data/yapi/config.json:/yapi/config.json \\
   yapipro/yapi \\
   server/app.js