共计 770 个字符，预计需要花费 2 分钟才能阅读完成。
产品升级会波及 API 的更改，当 API 改变较大时，最大的问题是如何告诉 API 的使用者（内部人员与应用 OPENAPI 的用户），咱们不能强制所有用户立刻对 API 的更改做出调整，然而也不能无限期的应用旧版本的 API。
所以，一旦在生产环境中运行了多个 API 版本，告诉使用者降级则成了一个大问题，复杂程度也与使用者的规模无关。意识到任何重大的更改对 API 的潜在影响，放弃与用户群良好的关系至关重要。
只管没有明确的规定多长时间须要更新 API 版本，然而思考到整个团队，强烈建议在任何给定的工夫内生产中的次要 API 版本永远不要超过两个。这能够让团队每次须要降级版本时都具备统一且牢靠的转换过程，而不用放心治理太多且看似随机的 API。
不论给定多少版本的 API，分明的传播与 API 版本更新相干的工夫和更改内容是确保顺利降级的要害。API 弃用告诉应该尽早发送给使用者，通常是在新的 API 版本筹备公布前，音讯应包含所有内容，例如正在进行的更改，影响到哪些更新，使用者须要采取哪些操作来防止任何呈现的问题。
如何能力疾速并且及时的告诉用户 API 更新信息。因为应用用户的环境不同，有些用户是离线环境，有些则是规定应用某一类型文档，导致 API 文档有很多种形式，例如：HTML、WORD 文档、EXCEL 文档…还包含一些热门的在线文档、API 文档工具，如 swagger、eolinker 等。如果您的文档以某一格局类型存在，制作一份文档则须要制作不同格局而内容雷同的文档，工作量是很大的。
API 文档工具能够帮忙咱们解决以上问题，以 Eolinker 为例，在放弃文档清晰可读的同时，Eolinker 能够在线分享文档，或导出多种格局文档，并反对告诉…大大降低了工作量，Eolinker 是一个适配不同规模团队的 Saas 工具，同时也反对私有化部署。
应用地址：www.eolinker.com