创建接口
接口（Application Programming Interface）是互联网中各个应用程序之间的连接。在软件层面上，接口在各项应用程序间提供服务，相互传递数据。同时接口也是自动化测试的单位，当各项接口测试后都能按照预期工作时，即说明服务运行正常。除了手动创建接口外，还可以通过外部软件（如 Swagger、Postman、Jmeter、HAR）导入。
创建接口文档
进入项目后，访问左侧导航栏中的“API 管理”，点击“默认文档”中右上角的“新建文档”按钮。
手动创建接口
接口文档由各个接口组成。点击接口目录下的蓝色创建按钮，点选“新建接口”。
定义接口名称、调整接口状态、设置请求参数与响应参数、添加相关字段说明；为每个接口新增成功、失败示例以完成创建。
导入外部接口
点击接口创建页中的“导入接口”按钮。
支持从第三方服务中导入接口，需遵循以下版本或以上：
- Swagger 2.0
- Postman 2.1
- Jmeter 5.1
接口状态说明
接口状态用于快速描述当前接口的开发维护情况，点击接口中的“编辑”选项进行修改与调整。
| 状态 | 说明 |
|---|---|
| 未开始 | 接口仅完成定义，还未开始开发实现。 |
| 开发中 | 接口开发中，接口定义会随时调整 |
| 测试中 | 接口开发完成，自测/测试进行中 |
| 已发布 | 接口已开发完成，通过测试，发布到线上或其他稳定环境 |
| 已废弃 | 接口废弃，不再维护，接口相关的逻辑随时失效 |
查看版本历史
导入接口后，所有的编辑历史都将以版本形式进行记录，你可以在右上角的菜单按钮中查看较早前的历史版本。
删除接口
访问任一接口，点击接口右侧菜单按钮中的“删除接口”选项。
问题反馈 >
2023-03-20最近更新感谢反馈有用
感谢反馈没用
在阅读中是否遇到以下问题？*
您希望我们如何改进？*
如果您希望得到回复，请留下您的邮箱地址。
