检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API生产 安全性 可用性 易用性 可维护性 父主题: 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:创建API资产成功后,所有用户都能在API中心门户网站中看到该API资产。 私有:创建API资产成功后,仅创建该API资产的用户能在API中心门户网站中看到该API资产。 标签
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角“创建API分组 > 创建API分组”。 表1 配置分组信息 参数 配置说明 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”,创建API分组。系统会同时为其分配一个子域名,您可以用于调试API。
如果是来源于华为云市场的API商品,可按照页面提示完成购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 如果是其他来源的技术开放型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治理规范指导 概述 规范要求 工具平台
当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性
检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized to access the API. 检查APP是否授权访问API。 401 APIC.0305
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(offset)。查询资源列表需要返回符合查询条件的资源总数(count)、查询数量(limit)、位移量(offset)。 举例:查询虚拟机从第10条开始,查询后100条。
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection