业务场景

一直有一个很难受的问题困扰者我们和使用者:当我们把文档的分享链接分享出去之后,由于文档和当前操作的接口数据是实时一致的,导致很多时候,后端人员一不小心的保存就会造成前端文档的更改

解决办法

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

【接口工具ApiPost】文档归档(9)_接口测试

查看并管理已归档文档

路径:顶部菜单栏–》归档管理

【接口工具ApiPost】文档归档(9)_接口单元测试_02


归档管理面板:

【接口工具ApiPost】文档归档(9)_接口单元测试_03

  1. 此页面是归档管理页面,取消归档或者更新不会影响接口数据
  2. 全选
  3. 批量更新归档
  4. 批量取消归档
  5. 目录
  6. 接口
  7. 关闭归档管理

归档管理 – 单个接口预览如下图:

【接口工具ApiPost】文档归档(9)_APIPost_04


依次可查看:基本信息、描述、Header、请求Query、请求Body。

【接口工具ApiPost】文档归档(9)_前端_05


【接口工具ApiPost】文档归档(9)_接口测试_06


【接口工具ApiPost】文档归档(9)_APIPost_07

【接口工具ApiPost】文档归档(9)_APIPost_08

另:文档归档可以简单理解为将文档进行快照,前端用户通过分享链接查看的文档内容是快照的内容,不会随着后端的保存更改而更改,避免了后端由于临时测试、修改某接口而影响已确定文档的修改。
您也可以通过归档管理随时取消或者更新文档快照。

好用的api接口开发工具

历时一年半多开发终于smartApi-v1.0.0版本在2023-09-15晚十点正式上线
smartApi是一款对标国外的postman的api调试开发工具,由于开发人力就作者一个所以人力有限,因此v1.0.0版本功能进行精简,大功能项有:

  • api参数填写
  • api请求响应数据展示
  • PDF形式的分享文档
  • Mock本地化解决方案
  • api列表数据本地化处理
  • 再加上UI方面的打磨

下面是一段smartApi使用介绍:

【接口工具ApiPost】文档归档(9)_API_09

下载地址:

https://pan.baidu.com/s/1NFm7QiUYRW_nu-ECwnKZ1g?pwd=51ct