API中心 API Hub-易用性:API名称必须易于理解、见名知义

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

API名称必须易于理解、见名知义

本条规则是Should类型的扩展规则,可提升API调用者的使用体验。

  • API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。
  • 在生产环境的API不能包含“test、uat、sit、beta”等字样,API名称只支持中文、字母、数字以及“_”或者"-",API名称长度建议不超过150字符。

例如:易于理解的API名称应为“查询虚拟机列表”/“ListServers”、“创建VPC网络”/“CreateVPC”

support.huaweicloud.com/productdesc-apihub/apihub_01_0025.html