使用接口文档快照机制,让接口文档不在频繁变动

码农小文

文档归档

什么是文档归档?

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

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

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

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

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

简单总结

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

您也可以通过归档管理随时取消或者更新文档快照。

阅读 443
7 声望
0 粉丝
0 条评论
7 声望
0 粉丝
文章目录
宣传栏