检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
0:非流控错误。 1:流控错误。 26 auth_type API认证类型。 27 access_model1 认证模式1。 28 access_model2 认证模式2,开启双重认证时,为自定义认证编号。 29 inner_time apig的内部处理时长,单位秒。 30 proxy_protocol_vni
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
选择实例类型,以APIG实例为例。 购买实例。 创建APIG实例。 图2 配置实例信息 表1 配置实例信息 参数 配置说明 计费模式 选择实例的计费模式,此处选择“按需计费”。 区域 选择实例所在的区域,此处选择“华北-北京四”。 可用区 选择实例所在的可用区,此处选择“可用区1”。
网关响应指未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default)。如需创建网关响应,请参考配置网关响应。 匹配模式 分为两种模式: 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。 前缀匹配:调用的请求Path将以创建时填写的API请求Pat
在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 单击,导入文件。 导出 API设计文件以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 根据需要导出文件的格式,单击,选择“导出YAML/导出JSON”导出文件。
Mock类型定义后端服务 服务参数 参数说明 Mock返回结果 Mock一般用于开发调试验证。在应用初始阶段,后端服务没有搭建好API联调环境,可以使用Mock模式,将预期结果固定返回给API调用方,方便调用方进行应用开发。 后端认证 当您的后端服务需要对API调用增加自己的认证,则需要开启后端认证。
支持选择扩展字段在设计文件“表单”中显示的区域。 API基本信息 请求参数 数据模型基本信息 数据模型属性 将鼠标移至“显示区域”右侧的问号,单击“了解扩展字段显示区域”查看扩展字段对应区域显示详情。 描述 填写扩展字段的描述信息。 配置扩展字段。 进入API设计文件详情,在“表单”中找到定义扩展字段时选择的区域,并配置扩展字段。
订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。 说明: 如果API已定义for
质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通
头。 可见范围 当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 根据不同的策略类型,策略内容的配置不同: 跨域资源共享策略 HTTP响应头管理策略 传统策略请参考: 流量控制策略
如需修复问题,单击“修复问题”根据修改建议修改问题。 图2 API导入规则检查结果 如忽略问题,可单击“继续导入”。 (可选)可视化设计API文件。 单击“表单”页签,您可以创建多个API文件或对API文件进行分类,以及可视化编辑API接口等。 在“API列表”区域,单击,创建API。 在“API列表”区域,单击,对API进行分类管理。