检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API。 选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提
API分组”。 单击右上角的“创建API分组”,选择下拉框中的“导入Swagger文件”。 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。 填写导入信息。 表2 导入API 参数名称 说明 导入方式 导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件
选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了Swagger规范定义项外,还包括API网关代理的一些Swagger扩展字段。
Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。
PI中心管理控制台的以下功能: API资产分享:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。 A
问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。
根据后端服务实际的参数名称和参数位置修改映射关系,如图1所示。 图1 配置后端服务参数 后端参数在“PATH”位置,那么参数名称需要和“路径”中的名称相同。 调用API的请求参数名称、位置可以与后端参数名称、位置不同。 参数名不能是x-apig- 、x-sdk-开头,不区分大小写。 参数名不能是x-stage,不区分大小写。
Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。
X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency 从API网关代理请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: deb
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
当使用非application/json媒体类型时,建议根据情况选择合适的媒体格式,具体情况如表2所示。 表2 常见的媒体类型 分类 场景 媒体类型 文件上传/下载类 文件上传下载类的接口,直接传递的是文件内容。 须知: 不建议使用该API进行文件传输。 application/octet-stream
POST:请求方法,需替换为获取API的请求信息中获取的请求方法。 {Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Que
检查域名、方法、路径和注册的API是否一致。 检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名。 500 APIC.0103 The backend does not exist. 联系技术支持。 500 APIC.0104 The plug-ins
华为云:负责云服务自身的安全,提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全,涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身,也包括
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者,并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer,并将其作为API中心的API调试
阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。 HTTP方法的需要符合幂等性的约束,幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用,单
是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理