关于前端:使用接口文档快照机制让接口文档不在频繁变动

5次阅读

共计 393 个字符,预计需要花费 1 分钟才能阅读完成。

文档归档

什么是文档归档?

在 ApiPost 之前的版本里,始终有一个很好受的问题困扰者咱们和使用者:当咱们把文档的分享链接分享进来之后,因为文档和以后操作的接口数据是实时统一的,导致很多时候,后端人员一不小心的保留就会造成前端文档的更改。

于是,通过咱们团队的强烈探讨,定下了这个计划:文档归档机制。

所谓“文档归档”是指,此文档一旦被归档,那么前端展现的文档就是归档那个时刻的文档快照,不会随着客户端的长期批改导致的接口保留而扭转。未归档的状况下,文档页面仍是实时文档。

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

通过点击归档文档治理查看并治理,一旦勾销归档后,文档页回到实时模式。

简略总结

文档归档能够简略了解为将文档进行快照,前端用户通过分享链接查看的文档内容是快照的内容,不会随着后端的保留更改而更改,防止了后端因为长期测试、批改某接口而影响已确定文档的批改。

您也能够通过归档治理随时勾销或者更新文档快照。

正文完
 0