yapi的一些基本操作 - 山之阿

时间:2024-03-09 14:20:16

yapi的一些基本操作

一、yapi能干什么

  1. 强大的接口管理平台
  2. 提供mock功能
  3. 提供测试功能
  4. 项目管理功能
  5. 插件齐全

二、yapi的权限

项目权限

操作 游客 项目开发者 项目组长 超级管理员
浏览公开项目与接口
浏览私有项目与接口
编辑项目信息
新建接口
编辑接口
删除项目

分组权限

操作 游客 分组开发着 分组组长 超级管理员
浏览分组
在分组中新建项目
编辑分组信息
管理分组成员
删除分组

三、注册用户

  • 怎么注册用户
    image

  • 刚注册完的用户,在未加入任何分组,和任何项目组之前,都属于游客。

四、分组

1、新建分组

image

注意:

个人空间为自己私有分组,就比如登录服务器之后自己的家目录,你可以用这个目录新建任何项目。

新建分组只有系统管理员才有权限,其他用户皆无此权限

2、分组能做什么

  1. 举个栗子:b公司有很多业务线,每个业务线下面有多个项目,那个一个业务线就可以单独设置一个分组,一个分组下面有多个项目。

  2. 编辑组成员
    image

  3. 添加项目

image

  1. 分组设置(一些组的其他设置)

    image

五、项目

  1. 新建接口

    image

  2. 项目成员变动

image

  1. 项目编辑

image

六、接口

  1. 新增接口

image

新增接口时,并不能直接去编辑参数等内容,需要新增之后才可以编辑

  1. 接口编辑

image

注意:添加之后一定要点击一下,底部的保存按键

  1. 运行接口
    image

七、其他要补充的

  • yapi可以直接从postman种导入数据
  • 个人感觉yapi是一个在线版、增强版的postman,但是新增了项目管理,测试集,mock等功能
  • 录入接口之后,数据会存储在数据库,到时候可以对数据库种的接口做监控使用,并非是仅仅监控一个端口,而是可以对每一个接口进行监控
  • 推荐使用,使用之后就不用word文档来管理接口了,每一次有改动还要重新发一次文档,找都不好找,对于全后端分离的项目来说yapi还为前端人员提供了mock功能,这样前端人员需要调试有关于数据相关的功能,就不用等后端开发出接口才能调试
  • 此次只说明了yapi最基本的一些功能