Api

El objeto que describe unApitipo de origen de evento. Si unAWS::Serverless::Apise define, los valores de ruta y método deben corresponder a una operación de la definición de OpenAPI de la API.

Si noAWS::Serverless::Apise define, la entrada y salida de la función son una representación de la solicitud HTTP y de la respuesta HTTP.

Por ejemplo, mediante la API de JavaScript, el statusCode y el cuerpo de la respuesta se pueden controlar devolviendo un objeto con las claves StatusCode y body.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  Auth: ApiFunctionAuth
  Method: String
  Path: String
  RequestModel: RequestModel
  RequestParameters: String | RequestParameter
  RestApiId: String

Properties

Auth

Configuración de autenticación para esta API específica y ruta+método.

Útil para anular las APIDefaultAuthorizerconfigurar la configuración de autenticación en una ruta individual cuando noDefaultAuthorizerse especifica o anula el valor predeterminadoApiKeyRequiredconfiguración de.

Type: Auth de función API

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Method

Método HTTP para el que se invoca esta función.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Path

Ruta de uri para la que se invoca esta función. Debe empezar por/.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

RequestModel

Solicite el modelo que se utilizará para esta API específica +ruta+método. Esto debería hacer referencia al nombre de un modelo especificado en elModelssección de unAWS::Serverless::Apirecurso.

Type: RequestModel

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

RequestParameters

Solicite la configuración de parámetros para esta API específica +ruta y método. Todos los nombres de parámetros deben empezar pormethod.requesty debe limitarse amethod.request.header,method.request.querystring, o bienmethod.request.path.

Si un parámetro es una cadena y no un objeto de parámetro de solicitud de función,RequiredyCachingEl valor predeterminado es falso.

Type: String |Solicitud de parámetro

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

RestApiId

Identificador de un recurso de RestApi, que debe contener una operación con la ruta y el método dados. Normalmente, esto se establece para hacer referencia aAWS::Serverless::Apirecurso definido en esta plantilla.

Si no define esta propiedad,AWS SAMcrea un valor predeterminadoAWS::Serverless::Apirecurso mediante un generadoOpenApino válido. Ese recurso contiene una unión de todas las rutas y métodos definidos porApieventos de la misma plantilla que no especifican unRestApiId.

Esto no puede hacer referencia a unAWS::Serverless::Apirecurso definido en otra plantilla.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

Evento API

Un ejemplo de Evento Api

YAML

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