【推荐】什么是文档归档?

V5.2.3版本后,ApiPost开始支持“文档归档”。

什么是文档归档?

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

为了避免此情况的发生,我们在上个版本(V5.2.1和5.2.2)做了一个尝试:把接口保存和文档保存分开,接口保存不会保存文档。但是造成的后果就是:明明我们的目录有数据,因为没有点击文档保存,导致分享数据的文档链接就是没有数据,或者,每次我新建一个接口都需要重新保存接口并保存文档,增加了用户的操作成本。

于是,经过我们团队的激烈探讨,V5.2.3版本起,定下了这个方案:文档归档机制。

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

怎么查看并管理已归档文档?

通过点击归档文档管理查看并管理,一旦取消归档后,文档页回到实时模式。

附:ApiPost简介:

ApiPost是一个支持团队协作,并可直接生成文档的API调试、管理工具。它支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。

你可能感兴趣的:(【推荐】什么是文档归档?)