检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
API生产便捷高效 通过对接集成，API中心为开发者引入API生产工具：API Arts。 API设计、测试一站式高效协同，API数据自动同步。 API设计与文档实时同步，设计即文档。 API测试与设计同源，设计示例一键导入测试步骤。 API开放简单体验 一键上架：API生产工具中的API资产可以一键上架到API门户，实现开放分享。
通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。 父主题： 安全
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件
支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护性，生命周期管理六个维度针对API生产（API设计/开发/测试）和API开放提供规则建议。 安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。
原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，必须将API修订的记录按照时间和版本顺序排列进行条目化，具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15
Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。 在API的设计阶段需要对单位时间可处理的能力进行设计，指标包括吞吐量和并发量。 吞吐量（TPS）是指服务在单位时间内处理请求的数量，使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。
同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建环境。 发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待发布的API所在行，单击“操作”列的“发布”。 批量发布API：在API列表页，批量勾选API，单击正上
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API Arts工具界面。 参考API设计和API测试章节指导，在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称，进入目标项目详情页面。 在左侧
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具（如华为云API Arts），进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API Arts工具界面。 参考API设计和API测试章节指导，在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称，进入目标项目详情页面。 在左侧
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验（高效协同、自动化等）的API工具，并对接集成引入到API中心的API工具库，供API开发者使用。
API的描述。 根据下表参数信息，配置安全配置。 表2 安全配置 信息项 描述 安全认证 API认证方式： APP认证：表示由API网关代理负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证：表示由IAM对API请求进行安全认证。 无认证：表示API请求不需要认证。
建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，POST请求是向指定的资源提交要被处理的数据，其响应不会被缓存；PUT请求用来提交数据时，其响应是不能被缓存的。
工具平台 API生产阶段 API中心通过对接集成，为API开发者提供API Arts等自动化的API设计/开发/测试工具，开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者（API提供方）可以在API中心申请入驻为服务商，然后自助发布上架API。上架成功后，API
例如：易于理解的API名称应为“查询虚拟机列表”/“ListServers”、“创建VPC网络”/“CreateVPC” API描述信息必须易于理解，表述准确 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API描述信息要易于理解，字面表述准确，能说明API的用途，场景及约束。
修订记录 发布日期 修订记录 2023-07-14 第九次正式发布。 优化如下章节： 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节： 取消入驻服务商 优化如下章节： 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。
本文档为您提供生产API、开放API、消费API的操作指导。您可以根据自身需求，选择一个或多个场景进行操作。 生产API：通过API工具库中提供的工具，完成API的设计、测试。 开放API： 上架API至API中心门户网站：通过创建API资产，将您开发好的API分享在API中心门户网站，供其他开发者调用。
PI经济。 为什么选择API中心 覆盖API生产、API开放、API消费全场景，一站式体验。 引入自动化的API工具，帮助API开发者高效设计/开发/测试API。 通过智能搜索和推荐，帮助应用开发者从海量API中快速找到所需API。 体系化、精细化的数据分析，帮助伙伴驱动API业务创新和发展。
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节： 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节： 约束与限制 2023-05-22 第六次正式发布。 新增如下章节： 图解API中心 优化如下章节： 产品优势 2023-03-31
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
