API中心 API Hub-可维护性:API建议明确标识出版本号

时间：2025-02-12 14:54:50

API中心 API Hub API生产

API建议明确标识出版本号

本条规则是Should类型的扩展规则，可提升API的可维护性。

每个API建议带上版本号，保证API的版本显性化，容易被API调用者所识别。版本号建议放置在URI中，用于显性标识所请求的API版本。

服务所提供的API版本定义统一规范成“vX”，这里X是一个正整数如：v1，v2等，要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本，哪些版本是支持但已经不推荐的版本，方便API调用者通过该接口快速了解与跟进服务API的变化。如果无法在URI中进行API版本标识，则可在HTTP Header中进行API版本标识。

例如：应用A提供API查询虚拟机列表GET /servers，可在URI上进行版本标识，如GET /v1/servers，GET /v2/servers，同时提供相关的API文档说明不同版本之间的区别。

上一篇：API中心 API Hub-可维护性:API请求HTTP动词使用标准化且满足幂等性

下一篇：API中心 API Hub-可维护性:API请求HTTP动词使用标准化且满足幂等性