Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

x-amazon-apigateway-auth 对象

在 API Gateway 中定义为方法调用的身份验证应用的身份验证类型。

属性

属性名称 类型 描述
type string 指定身份验证类型。为开放访问指定 "NONE"。指定 "AWS_IAM" 使用 IAM 权限。值不区分大小写。

x-amazon-apigateway-auth 示例

下面的示例为 REST API 方法设置身份验证类型。

OpenAPI 3.0.1
OpenAPI 3.0.1
{ "openapi": "3.0.1", "info": { "title": "openapi3", "version": "2018-12-04T05:22:50Z" }, "servers": [ { "url": "https://hs8l62bm7l.execute-api.us-west-2.amazonaws.com/{basePath}", "variables": { "basePath": { "default": "/dev" } } } ], "security": [ { "api_key": [] } ], "paths": { "/key": { "get": { "x-amazon-apigateway-auth": { "type": "NONE" }, "security": [ { "api_key": [] } ] } } }, "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" } } } }