检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
工具平台 API生产阶段 API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。上架成功后,API
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。
在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性
通过对接集成,API中心为开发者引入API生产工具:API Arts。 API设计、测试一站式高效协同,API数据自动同步。 API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:API生产工具中的API资产可以一键上架到API门户,实现开放分享。
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者,并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer,并将其作为API中心的API调试
如果您想要使用API中心提供的工具开发API,请参考本章指导操作。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。
团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。 API技术开放 当前面临的主要问题 业界海量API碎片化分布,缺少统一的汇聚平台展示API。
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized to access the API. 检查APP是否授权访问API。
PI网关代理,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治理规范指导 概述 规范要求 工具平台
API数据分析 优化如下章节: 服务商入驻 API资产管理 创建API分组 发布API API工具库 2023-03-14 第五次正式发布。 优化如下章节: 使用前必读 服务商入驻 API工具库 2023-03-03 第四次正式发布。 优化如下章节: 服务商入驻 API资产管理 创建API分组
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四
状态码详细信息 200 OK 执行成功,如:查询成功响应。 201 Created 创建成功,如:创建记录成功。 400 Bad Request 客户端请求语义有误,当前请求无法被服务器理解或请求参数有误。 401 Unauthorized 当前请求需要用户验证,需要用户提供Token进行认证。
URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文
URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文
URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文
公测 约束与限制 4 服务商入驻优化 没有入驻API中心服务商的开发者,可以看到API中心管理控制台左侧导航栏的“API订阅管理”,“API工具库”,“AP门户”和“服务商入驻”几个菜单。 公测 服务商入驻 2023年1月 序号 功能名称 功能描述 阶段 相关文档 1 创建API资产新增两种导入方式