Api - AWS Serverless Application Model
语法属性示例
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Api

描述 Api 事件源类型。如果 AWS::Serverless::Api 资源,路径和方法值必须对应于 OpenAPI API的定义。

如果否 AWS::Serverless::Api 定义,函数输入和输出是HTTP请求和HTTP响应的表示。

例如,使用 JavaScript API、响应的状态代码和正文可以通过返回具有密钥的对象来控制 statusCode 和主体。

语法

若要在您的 AWS 无服务器应用程序模型 (AWS SAM)模板,请使用以下语法。

属性

Auth

此特定Api+Path+Method的身份验证配置。

可用于覆盖API的 DefaultAuthorizer 在单个路径上设置授权配置, DefaultAuthorizer 指定或覆盖默认值 ApiKeyRequired 设置。

类型: ApiFunctionAuth

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

Method

调用此功能的HTTP方法。

类型：字符串

必需: 是

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

Path

调用此函数的Uri路径。必须以开头 /.

类型：字符串

必需: 是

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

RequestModel

请求用于此特定Api+Path+Method的模型。这应该引用在 Models 部分 AWS::Serverless::Api 资源。

类型: RequestModel

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

RequestParameters

请求此特定Api+Path+Method的参数配置。所有参数名称必须以开头 method.request 且必须限制为 method.request.header, method.request.querystring,或 method.request.path.

如果参数是字符串而不是函数请求参数对象,则 Required 和 Caching 将默认为False。

类型:字符串| RequestParameter

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

RestApiId

的标识符 RestApi 资源,其中必须包含具有给定路径和方法的操作。通常,这设置为引用 AWS::Serverless::Api 此模板中定义的资源。

如果不定义这个属性, AWS SAM 创建默认 AWS::Serverless::Api 使用生成的 OpenApi 文档。该资源包含所有路径和方法的联合,这些路径和方法由 Api 不指定 RestApiId.

这不能引用 AWS::Serverless::Api 资源。

类型：字符串

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

示例

ApiEvent

Api事件示例

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization