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

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

文档归档

什么是文档归档?

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

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

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

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

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

简单总结

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

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

相关文章
|
1月前
|
开发工具 Android开发
Android项目架构设计问题之SDK内部减少每次回调时的冗余判断逻辑如何解决
Android项目架构设计问题之SDK内部减少每次回调时的冗余判断逻辑如何解决
17 0
|
4月前
|
运维 JavaScript Devops
云效产品使用报错问题之更新后,旧数据的完成时间导出来没有了如何解决
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
|
4月前
|
编解码
亚丁号自动阅读第一次更新
亚丁号自动阅读第一次更新
38 1
|
4月前
|
存储 JavaScript
uniapp在不需要后端数据的情况下 怎么记录用户进一次记录一次
uniapp在不需要后端数据的情况下 怎么记录用户进一次记录一次
61 0
|
12月前
如何进行需求评审后续跟踪和更新?附模板
如何进行需求评审后续跟踪和更新?附模板
117 0
uniapp bug记录(后续更新)
uniapp bug记录(后续更新)
117 0
|
程序员 测试技术 数据库
实战! 项目单据确认状态未更新排查
实战! 项目单据确认状态未更新排查
|
前端开发
前端工作小结76-整理订单的重置逻辑
前端工作小结76-整理订单的重置逻辑
75 0
前端工作小结76-整理订单的重置逻辑
|
存储 自然语言处理 Dubbo
几行代码轻松实现跨系统传递 traceId,再也不用担心对不上日志了!
新项目查日志太麻烦,多台机器之间查来查去,还不知道是不是同一个请求的。打印日志时使用 MDC 在日志上添加一个 traceId,那这个 traceId 如何跨系统传递呢?
1122 0