一、团队和项目管理
(一)团队管理
建议以组织名或者公司名命名
默认创建的团队是免费团队,赠送2个工位,最大支持2个团队成员的协作,可以在创建成功后进行版本升级和工位扩充。
免费团队中读写工位为两个
只读工位无上限
在上面可以切换团队和项目
(二)项目管理
一个团队中可以生成多个项目,可以在API Post中新建项目,也可以从Postman中导入项目
二、API
(一)添加参数环境
(二)接口说明
以提现接口为例 应描述接口的基本信息
- 接口功能
- 接口负责人
- 版本号
- 其他说明等
(三)参数说明
添加参数说明,用于文档生成
(四)添加响应示例及参数描述
API Post 可以根据添加的响应示例,自动提取字段和描述
较为复杂的字段也基本可以成功提取
(五)其他功能
1、锁定
ApiPost接口锁定功能:锁定状态下只有锁定这个接口的人能进修修改编辑,其他协作者只能进行查看和接口发送。
2、备份
ApiPost接口备份功能:点击创建备份,接口会被备份到服务器中
ApiPost接口还原功能:点击还原可以查看备份的接口,点击还原接口就会被还原成备份的接口
3、接口状态
可以将接口标记为
开发中
已完成
需修改
4、归档
文档归档是指此文档一旦被归档,那么前端展示的文档就是归档那个时刻的文档快照,不会随着客户端的临时修改导致的接口保存而改变。未归档的情况下,文档页面仍是实时文档。
三、分享
创建分享链接
设置密码和有效期
生成的文档也比较全面和整洁
四、流程测试
五、笔记
可以用来记录接口相关的工作
六、总结
以上是对Api Post使用的一个简单汇总,该软件还有更多的功能,详细内容请查看相应官网和官方文档。
除此之外 ApiPost 还有更多更好的功能,大家可以登陆官方网站下载体验:
Apipost-基于协作,不止于API文档、调试、Mock