一、团队和项目管理

(一)团队管理


Api Post 使用指南_接口测试

建议以组织名或者公司名命名

默认创建的团队是免费团队,赠送2个工位,最大支持2个团队成员的协作,可以在创建成功后进行版本升级和工位扩充。

免费团队中读写工位为两个

只读工位无上限

Api Post 使用指南_项目管理_02

在上面可以切换团队和项目

Api Post 使用指南_接口测试_03


(二)项目管理

一个团队中可以生成多个项目,可以在API Post中新建项目,也可以从Postman中导入项目

Api Post 使用指南_api_04

二、API

(一)添加参数环境


Api Post 使用指南_接口测试_05


Api Post 使用指南_接口测试_06


(二)接口说明

以提现接口为例

应描述接口的基本信息

  • 接口功能
  • 接口负责人
  • 版本号
  • 其他说明等

Api Post 使用指南_接口测试_07


(三)参数说明

添加参数说明,用于文档生成

Api Post 使用指南_api_08

(四)添加响应示例及参数描述

API Post 可以根据添加的响应示例,自动提取字段和描述

Api Post 使用指南_项目管理_09



Api Post 使用指南_api_10

较为复杂的字段也基本可以成功提取

Api Post 使用指南_接口测试_11

(五)其他功能

1、锁定

ApiPost接口锁定功能:锁定状态下只有锁定这个接口的人能进修修改编辑,其他协作者只能进行查看和接口发送。

2、备份

ApiPost接口备份功能:点击创建备份,接口会被备份到服务器中

ApiPost接口还原功能:点击还原可以查看备份的接口,点击还原接口就会被还原成备份的接口

3、接口状态

可以将接口标记为

开发中

已完成

需修改

Api Post 使用指南_api_12

4、归档

文档归档是指此文档一旦被归档,那么前端展示的文档就是归档那个时刻的文档快照,不会随着客户端的临时修改导致的接口保存而改变。未归档的情况下,文档页面仍是实时文档。

三、分享

创建分享链接

Api Post 使用指南_接口测试_13

设置密码和有效期

Api Post 使用指南_接口测试_14

生成的文档也比较全面和整洁

Api Post 使用指南_接口测试_15


四、流程测试


Api Post 使用指南_api_16


五、笔记

可以用来记录接口相关的工作

Api Post 使用指南_项目管理_17


六、总结

以上是对Api Post使用的一个简单汇总,该软件还有更多的功能,详细内容请查看相应官网和官方文档。


版权声明:本文为CSDN博主「Joshua_yi」的原创文章​