华为云首页用户手册

API网关 APIG-批量导出API:响应消息

API网关 APIG-批量导出API:响应消息

时间：2023-11-01 16:18:59

API网关 APIG

响应消息

表4 参数说明
名称	是否必选	参数类型	说明
swagger	是	String	固定值2.0
info	是	Object	参考表5
host	是	String	API分组绑定的子域名
paths	是	Object	参考表 paths参数说明
responses	是	Object	公用响应定义，可以被引用在{method}的操作中，参考表10
securityDefinitions	是	Object	定义鉴权方式，参考表14
x-apigateway-access-controls	否	Object	访问控制信息，参考表 x-apigateway-access-controls参数说明
x-apigateway-ratelimits	否	Object	流量空时信息，参考表 x-apigateway-ratelimits参数说明

表5 info参数说明
名称	是否必选	参数类型	说明
title	是	String	API分组名称
version	是	String	版本号，用户输入自定义版本号或者使用默认的当前时间
description	否	String	分组描述信息

表6 paths参数说明
名称	是否必选	参数类型	说明
uri	是	Object	API访问地址，参考表7

表7 uri参数说明
名称	是否必选	参数类型	说明
method	是	Object	API访问方法，参考表8

表8 method参数说明
名称	是否必选	参数类型	说明
operationId	是	String	API的名称
description	否	String	API的描述信息
schemes	是	Object	API的请求协议对象数组定义，支持http、https
tags	否	Object	API标签对象数组定义
parameters	否	Object	请求参数对象数组定义，参考表前端parameters参数说明
responses	是	Object	响应定义，参考表10
security	否	Object	API的认证类型对象数组定义，参考表 security参数说明
x-apigateway-access-control	否	Object	API绑定的访问控制对象数组定义
x-apigateway-backend	否	Object	API的后端信息，参考表 x-apigateway-backend参数说明
x-apigateway-backend-policies	否	Object	API的策略后端信息，参考表 x-apigateway-backend-policies参数说明
x-apigateway-cors	否	Boolean	是否支持跨域
x-apigateway-match-mode	否	String	API的匹配方式
x-apigateway-ratelimit	否	String	API绑定的流量控制名称
x-apigateway-request-type	否	String	API的类型

上一篇：API网关 APIG-查看自定义认证详情:响应消息

下一篇：API网关 APIG-创建自定义认证:请求消息

API网关 APIG-批量导出API:响应消息

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题