更新时间:2025-01-10 GMT+08:00
x-apigateway-auth-type
含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。
作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0)
Swagger:
securityDefinitions:
apig-auth-app:
in: header
name: Authorization
type: apiKey
x-apigateway-auth-type: AppSigv1
apig-auth-iam:
in: header
name: unused
type: apiKey
x-apigateway-auth-type: IAM
OpenAPI示例:
securitySchemes:
apig-auth-app:
in: header
name: Authorization
type: apiKey
x-apigateway-auth-type: AppSigv1
apig-auth-iam:
in: header
name: unused
type: apiKey
x-apigateway-auth-type: IAM
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
x-apigateway-auth-type |
是 |
String |
API网关认证方式,支持AppSigv1、IAM。 |
|
type |
是 |
String |
认证类型,仅支持apiKey。 |
|
name |
是 |
String |
用于认证的参数名称。 |
|
in |
是 |
String |
仅支持header。 |
|
description |
否 |
String |
描述信息。 |
父主题: APIG的API设计文件扩展定义