公关公司和广告公司的区别,seo工具助力集群式网站升级,怎样做咨询网站,无锡住房和城乡建设部网站一、基本概念
在API的整个生命周期中#xff0c;不可能是永远不变的。功能可能有变动、服务也可能有升级迭代#xff0c;这个时候对外的能力入口#xff1a;API自然也需要改变。
一般来说#xff0c;API的变动是不可以引入兼容性问题的#xff0c;也即不管做什么变动不可能是永远不变的。功能可能有变动、服务也可能有升级迭代这个时候对外的能力入口API自然也需要改变。
一般来说API的变动是不可以引入兼容性问题的也即不管做什么变动已经在使用的用户在不改变使用方式的前提下是必须无感知的假如接口需要新增一些必选参数、改变url等则必须要通过版本迭代的方法提供N1版本的接口在保持老接口不变的情况下为客户提供新接口、并引导存量服务使用起新接口。
在这期间我们就需要开始进行API的日落流程最终将API彻底下线。
二、日落流程
日落流程主要分成三个部分计划阶段、准备阶段以及实施阶段这三个阶段的注意事项我们分别接单看下。
1、计划阶段
1识别待下线接口制定下线计划
在API下线前服务需对API做梳理与识别并制定相关下线计划
下线原因最近12个月的调用量说明影响范围与相关评估替代方案正式下线时间采用下线策略与客户的沟通方法
2评审下线计划
在服务完成下线API的梳理与计划制定后需首先在产品团队内部进行相关评审在评审通过后还需在三级部门API TMG进行进一步的下线合理性评审。 在完成相关评审之后服务才可进行接下来的API下线准备工作。
2、准备阶段
1发布下线公告
服务需要在官方网站里发布对应的API下线公告内容应当包含API的下线时间、下线接口、替代接口等内容。
2更新API参考资料
服务需在API资料文档部分同步更新API信息与状态说明API为废弃状态、计划下线时间并且给出后续的替代API。 同时应当在API文档中也增加API公告章节便于用户获取API关键信息。
3增加计算机可感知API废弃告警
服务在接口的调用层面应当在Header中添加Deprecated信息
X-API-Deprecation-Date需提供API的具体废弃日期在该日期后API可能会被下线删除X-API-Deprecation-Info需提供访问链接指向关于废弃API的处理方法以及后续方案
4监控API使用并周期性提醒用户
在API用户完全切换到新接口之前需要保持原有接口的稳定性与可用性同时还需要监控API当前调用量与调用者定期通知用户尽快完成切换。
3、实施阶段
1API下线实施前评审
API实施下线前提
API实施下线需在公告发布12个月之后并且至少3个月之内接口无用户调用记录实施下线前需要再次经过API TMG评审
2API下线实施操作
API下线需要将API从网关中删除并将API文档、SDK、示例代码等内容全部下线。
3发布API下线公告
有始有终API下线后同样要在官网发布API下线公告。
三、小结
至此API的全生命周期就走到了结尾崭新的API也即将诞生这就是API的一生。
