检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023-03-31
图解API中心
appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。 handleTime:本次调用API的处理时间。 providerAppId:API提供者的凭据ID。 a
PI描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
如何获取API调用凭据? 如果是来源于华为云服务的API,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。