检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API Gateway API Gateway（Application
对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动，并在公告服务下线时间后1个月内对API调用进行监控，当没有API调用流量之后，才启动正式下线。待该API到了正式下线后，API中心不再展示下线的API。 父主题： API开放
帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时，支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面几种之一时，支持勾选部分接口导入。如果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
在API列表页，单击API所在行“操作”列的“编辑”，修改API参数信息。 创建策略并绑定API 通过对API添加策略，限制对API的访问，从而保护后端服务。 调试API 创建完API后，需要验证服务是否正常，管理控制台提供调试功能。 发布API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
产品架构 图1 API中心产品架构 API中心主要包括API工具，API门户，API网关代理，API运营四个产品模块： API工具 API中心通过对接集成API开发工具，为API开发者提供简单易用的API工具，帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
API分组是同一种业务API的集合，API开发者以API分组为单位，管理分组内的所有API。 域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限
在API资产列表页，单击API资产名称，查看API资产详情。 修改API资产信息 在API资产列表页，单击API资产所在行“操作”列的“编辑”，修改API资产信息。 删除API资产 在API资产列表页，单击API资产所在行“操作”列的“删除”。 查看API资产包含的接口信息 在AP
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角“创建API分组 > 创建API分组”。 表1 配置分组信息 参数 配置说明 分组名称 API分组名称，用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”，创建API分组。系统会同时为其分配一个子域名，您可以用于调试API。
的API分组。 API接口 当“导入方式”为下面几种之一时，支持勾选部分接口导入。如果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时，需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。
用API。 单击API资产，查看API资产的开发文档。 在需要调试的接口详情页面，单击“在线调试”。 部分API未提供调试功能，具体以详情页面展示的信息为准。 对于需要付费购买的API（来源于华为云市场的API），单击API资产，在API资产详情页面，单击“API接口”页签下的“调试API”，在线调试API。
对于需要付费购买的API（来源于华为云市场的API），单击API资产，在API资产详情页面，单击“API接口”页签下的“调试API”，在线调试API。 （可选）获取服务商联系方式。 对于不需要付费购买的API（技术开放型API），可以通过以下步骤获取API服务商的联系方式。 单击API资产。
(URI): Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC
创建API分组 API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。您在创建API前，需要先创建API分组。 目前支持两种创建分组方式： 创建API分组 创建一个简单的分组，不包含API，用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件，同步创建分组。
域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。
本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API对外开放时，API文档建议使用统一的模板，以便保持API参考文档的一致性，易于开发者理解。在API参考文档中必须包含如下内容： API目录，包括本次提供API的列表信息。
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
在左侧导航栏选择“API网关代理 > API列表”。 在待下线的API所在行，单击“更多>下线”。 批量下线API：在API列表页，批量勾选API，单击正上方的“下线”。最多同时批量下线1000个API。 选择API需要下线的环境。 单击“确定”，完成API下线。 后续操作 您将API下线后
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
