API领域中经常出现的一个话题是公司决定弃用API的版本,或者完全关闭对API的支持。 作为向公众提供API的团队,重要的是要制定一个计划,以计划如何管理不同版本的API的弃用和报废。那么团队如何最好地弃用API?首先,让我们了解API弃用的原因,然后重点介绍一些建议的做法以有效弃用。
何时不推荐使用API
弃用和禁用API的决定是一个困难的决定。没有正确的方法,但肯定有错误的方法。记住,如果不正确地弃用API,可能会损害公司的品牌声誉和信任度。 进行API弃用的原因有很多。弃用API版本可能是因为: API不安全 API有太多错误 该API不支持重要的用例 API效率低下 在当今快速发展的技术领域中,API不断添加新的和更新改进,旧版本也不断新增。如果可以迅速提供一种具有适当资源的良好和稳定的替代方案,则这种弃用形式不会对消费者的应用产生太大影响。 还有一种更永久的否决形式,完全删除或禁用API。这里,API已完全废弃,没有提供更新版本。API被废弃的一些原因是: 由于费用原因,该服务不再受支持 公司决定将资源投资于不同产品 该服务不再符合业务目标 这些决策通常可以归结为业务策略,以及API与公司收入或用户获取目标的一致性。尽管这个决定很困难,但是许多团队还是必须要经过一定的时间。
如何有效地弃用API
弃用是API的最后阶段,应谨慎行事。这可能会给最终用户带来很多挫败感,并且在某些情况下,可能会导致整个产品停产。这里有一些指导方针,以更好地做到这一点。
**诚实沟通 ** 当决定弃用API时,请对API的使用者保持开放和诚实。发送消息宣布预期的弃用,包括弃用时间范围,下一版本发布时间表以及其他信息(如支持,联系信息等)。这时API管理工具可以迅速派上用场的地方是查看访问使用API的用户列表。也可以在API开发人员门户及其文档中进行通信。例如,Eolinker开放平台,支持查看API用户列表。
提供足够长的弃用时间 在最初宣布弃用API之后的这段时间里,给API使用者时间重新配置他们的应用程序。一个好的弃用期很重要,因为它使依赖API的公司有时间来更改业务和技术策略。根据已弃用的API的覆盖范围,用户群和服务产品的不同,这段时间可能在3-8个月之间。
有效版本 使用有效的版本控制,可以更轻松地弃用特定版本的API。有了良好的版本控制,还可以同时使用不同版本的API。在完全弃用该API之前,构建并发布该API的下一版本。这与弃用期有关,为开发人员和工程师提供足够的时间来重做现有体系结构支持新的API。 Eolinker具有一个API版本控制系统,该系统允许同时存在API的多个版本和迭代,这是向最终用户提供有关API存在的各种版本以及推荐使用的版本的信息的最佳方法之一。
提供替代方案 许多应用程序和全面的软件解决方案都依赖于API才能正常运行。一个良好的迁移计划,可以使API使用者平稳过渡到API的最新版本,或者在完全删除API的情况下过渡到其他替代方案,这可以帮助减轻挫败感并维护最终使用者之间的信任。
总而言之,团队应该考虑为什么,何时以及如何禁用对API(无论是版本还是整个服务本身)的支持。都应该花费时间和精力通过提供正确的信息,正确的资源和正确的时间来帮助最终用户获得回报。最后,应该投资正确的工具和基础设施,管理、更新和最终淘汰不同版本的API。 本文使用Eolinker进行演示,如需了解更多请访问:www.eolinker.com