简介

目的

主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范，帮助伙伴、开发者构建并提供有质量保障的API服务，为平台营造良好能力开放与交互的环境，支撑华为云和伙伴及开发者共建API生态。

API治理规范主要从安全、可用性、易用性、可维护性，生命周期管理六个维度针对API生产（API设计/开发/测试）和API开放提供规则建议。

• 安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。
• 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。
• 易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。
• 可维护性：对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议，提升API可维护性。
• 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。

包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。

适用范围

在华为云API中心发布、用于面向公众开放信息和服务的API。此类API可以充分发挥开发者的创造性，增加企业业务覆盖面和访问流量，是企业新的商业模式和收入来源。

读者对象

API构建者包括：架构师、开发、测试、运维、产品经理、CTO等。