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

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

文档归档

什么是文档归档?

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

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

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

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

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

简单总结

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

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

相关文章
|
4月前
|
开发工具 Android开发
Android项目架构设计问题之SDK内部减少每次回调时的冗余判断逻辑如何解决
Android项目架构设计问题之SDK内部减少每次回调时的冗余判断逻辑如何解决
47 0
|
6月前
|
消息中间件 存储 Serverless
函数计算产品使用问题之想要请求持久化该怎么操作
函数计算产品作为一种事件驱动的全托管计算服务,让用户能够专注于业务逻辑的编写,而无需关心底层服务器的管理与运维。你可以有效地利用函数计算产品来支撑各类应用场景,从简单的数据处理到复杂的业务逻辑,实现快速、高效、低成本的云上部署与运维。以下是一些关于使用函数计算产品的合集和要点,帮助你更好地理解和应用这一服务。
|
7月前
|
监控 安全 网络安全
接口频繁请求,被刷爆怎么办
接口频繁请求,被刷爆怎么办
|
7月前
|
编解码
亚丁号自动阅读第一次更新
亚丁号自动阅读第一次更新
50 1
|
C# C++
[记录]c/c++和c#联调常见问题
[记录]c/c++和c#联调常见问题
|
消息中间件 Java Kafka
kakfa 常见错误(长期更新)
kakfa 常见错误(长期更新)
541 1
uniapp bug记录(后续更新)
uniapp bug记录(后续更新)
129 0
|
缓存 小程序 API
小程序:浅谈小程序更新机制,发版后多久能全覆盖
小程序:浅谈小程序更新机制,发版后多久能全覆盖
457 0
|
存储 自然语言处理 Dubbo
几行代码轻松实现跨系统传递 traceId,再也不用担心对不上日志了!
新项目查日志太麻烦,多台机器之间查来查去,还不知道是不是同一个请求的。打印日志时使用 MDC 在日志上添加一个 traceId,那这个 traceId 如何跨系统传递呢?
1179 0

热门文章

最新文章