检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录-API治理规范指导 概述 规范要求 工具平台
概述 简介 术语 父主题： 附录-API治理规范指导
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API分组 创建API分组 域名管理 环境变量 父主题： API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题： API网关代理
服务商 服务商入驻 变更服务商信息 取消入驻服务商
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节： 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节： 约束与限制 2023-05-22 第六次正式发布。 新增如下章节： 图解API中心 优化如下章节： 产品优势 2023-03-31
图解API中心
"count":1540 } API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取，输出参数要让开发者易于理解。降低开发者使用API的使用成本，提升API使用体验。避免API的输入参数要通过多次前置条件API的查询获得。
商业变现通道。 华为云集成工作台 API中心可以通过对接aPaaS集成工作台的集成框架，支持aPaaS集成工作台获取并使用API资产元数据，用于连接器的创建和使用。
接口定义多个不同Path。 例如，请求路径为/test/AA，使用前缀匹配时，通过/test/AA/CC可以访问，但是通过/test/AACC无法访问。 说明： 使用前缀匹配时，匹配剩余的路径将透传到后端。 例如，使用前缀匹配，前端请求路径定义为/test/，后端请求路径定义为/
2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。
生产API 使用场景 如果您想要使用API中心提供的工具开发API，请参考本章指导操作。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API
已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验（高效协同、自动化等）的API工具，并对接集成引入到API中心的API工具库，供API开发者使用。 API技术开放 当前面临的主要问题 业界海量API碎片化分布，缺少统一的汇聚平台展示API。 应用开发者缺少行业价值API的获取途径，不清楚哪些API可用。
根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 Aes：填写Aes认证所使用的密钥Key。 Public Key：填写Public Key认证所使用的公钥。 Secret 根据选择的密钥类型，填写不同的密钥信息。
配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本，TLS1.1或TLS1.2，推荐使用TLS1.2。 该配置仅对HTTPS生效，不影响HTTP或者其他访问方式。 单击“确定”，将独立域名与API分组绑定。
与“API流量限制”配合使用，表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用，表示“时长”时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用，表示“时长”时间内的单个IP地址请求次数上限。
如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
