yapi/doc/page/usage/api.md
2017-11-02 19:57:34 +08:00

1.7 KiB
Executable File
Raw Blame History

进入项目页可以看到项目下的所有接口需要注意的是YApi有 接口集合测试集合 两个概念。

  • 接口集合 将接口进行分类,使结构结构更清晰,一个接口只能属于一个集合,且不允许与其他接口重名。
  • 测试集合 为了方便我们测试接口,测试集合 将若干接口组合在一起,在这里一个接口可以属于不同集合。

接口配置

新建接口 后,点击新添加的接口,右侧可以看到接口的预览信息,点击右侧的 编辑 Tab项进入编辑面板。

在改面板中你可以看到接口的基本信息(接口名称、分类、路径),除此以外,你还可以完善以下接口信息:

  • Path: 接口路径,支持 restful 动态路由,例如 /api/:id, id是动态参数
  • 状态: 用于标识接口是否开发完成。
  • 接口描述: 用简短的文字描述接口的作用。
  • query: 接口url的查询字符串。
  • 请求 Headers: http 请求头字段。
  • 请求 Body: http 请求 body 部分。
  • 请求 Body: http 请求 body 部分。
  • 响应 Body: 模拟返回结果。

响应 Body 分为 json & raw 两种形式

  • 是否开启邮件通知:开启后将此次接口的改动以邮件的形式发送至项目组所有成员。

接口运行

接口运行功能是用来测试真实接口的类似『Postman』的功能。

点击运行 tab ,可进入到接口测试页面,首先安装『chrome crossRequest』扩展才可正常使用此功能。

安装完插件记得刷新页面

点击保存按钮可把当前测试保存到测试集,方便下次调试。