API版本管理中的沟通问题

产品升级会涉及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