检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API设计、测试一站式高效协同,API数据自动同步。 API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:API生产工具中的API资产可以一键上架到API门户,实现开放分享。
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。
工具平台 API生产阶段 API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。
读者对象 API构建者包括:架构师、开发、测试、运维、产品经理、CTO等。 父主题: 概述
调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。
参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建API资产”页面。
参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建API资产”页面。
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行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调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入
支持区域: 华北-北京四 服务商入驻 变更服务商信息 取消入驻服务商 生产API API中心为开发者引入自动化的API工具(如API Arts),帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。
API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 创建API分组 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API分组”,选择下拉框中的“创建API分组”。
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%
术语 API API(Application Programming Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。 API Gateway API Gateway