检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 简介 术语 父主题： 附录-API治理规范指导
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
图解API中心 优化如下章节： 产品优势 2023-03-31 第五次正式发布。 优化如下章节： 什么是API中心 应用场景 产品功能 与其他服务的关系 2023-03-22 第四次正式发布。 优化如下章节： 产品功能 2023-03-03 第三次正式发布。 优化如下章节： 产品功能 2023-02-10
图解API中心
Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
填凭据详情中“AppCode”的值），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证，且开启了简易认证模式，API请求既可以选择使用Key和Secret做签名和校验，也可以选择使用AppCode进行简易认证。 为
华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括
API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
生产API 使用场景 如果您想要使用API中心提供的工具开发API，请参考本章指导操作。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API
（可选）配置默认后端的后端服务参数，将调用API时传入的请求参数映射到后端服务请求的对应位置。如果表3 请求参数中未定义请求参数，可直接跳过此步骤。 在“后端服务参数”下，可通过以下任意一种方法添加后端服务参数。 单击“导入入参定义”，把所有已定义的API请求参数添加到后端服务参数。 单击
从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时，返回此参数 X-Apig-Upstream-Latency 从API网关代理请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug，且后端服务类型不为Mock时，返回此参数
下线API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取，输出参数要让开发者易于理解。降低开发者使用API的使用成本，提升API使用体验。避免API的输入参数要通过多次前置条件API的查询获得。 父主题：
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件
PI资产。 按服务商维度展示：展示所有API资产的服务商。可以在左侧勾选分类，按行业筛选API资产服务商。单击服务商，可以看到该服务商拥有的所有API资产。 查看系统精选API 勾选“仅看精选”，界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后，单击A
阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单
共享流控：针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。时长单位支持秒，分钟，小时，天。 与“API流量限制”配合使用，表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用，表示“时长”时间内的单个凭据请求次数上限。
变更服务商信息 服务商入驻成功后，您如果想要修改服务商信息，可以参考本章指导操作。 前提条件 仅允许华为云账号修改服务商信息，不允许该账号下的IAM用户修改服务商信息。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面，单击“变更服务商信息”
取消入驻服务商 您如果想要取消在API中心入驻服务商，可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商，不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
