Api

L'oggetto che descrive unApitipo di origine evento. Se unAWS::Serverless::Apila risorsa è definita, i valori del percorso e del metodo devono corrispondere a un'operazione nella definizione OpenAPI dell'API.

Se noAWS::Serverless::Apiè definito, l'input e l'output della funzione sono una rappresentazione della richiesta HTTP e della risposta HTTP.

Ad esempio, utilizzando l'API JavaScript, il statusCode e il corpo della risposta possono essere controllati restituendo un oggetto con le chiavi StatusCode e body.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

YAML

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

Proprietà

Auth

Configurazione di autenticazione per questo metodo API+Path+Path.

Utile per sovrascrivere le APIDefaultAuthorizerimpostazione della configurazione di autenticazione su un singolo percorso quando noDefaultAuthorizerè specificato o sostituisce il valore predefinitoApiKeyRequiredimpostazione.

Type: Autenticazione delle funzioni API

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Method

Metodo HTTP per il quale viene richiamata questa funzione.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Path

Percorso Uri per il quale viene richiamata questa funzione. Deve iniziare con/.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

RequestModel

Richiedi un modello da utilizzare per questo metodo API+Path+Path+specifico. Questo dovrebbe fare riferimento al nome di un modello specificato nellaModelssezione di unAWS::Serverless::Apirisorsa.

Type: Richiesta modello

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

RequestParameters

Richiedi la configurazione dei parametri per questo metodo API+Path+Path+specifico. Tutti i nomi dei parametri devono iniziare conmethod.requeste deve essere limitato amethod.request.header,method.request.querystring, oppuremethod.request.path.

Se un parametro è una stringa e non un oggetto Parametro di richiesta funzione, alloraRequiredeCachingIl valore predefinito è false.

Type: Stringa |RequestParametro

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

RestApiId

Identificatore di una risorsa RestApi, che deve contenere un'operazione con il percorso e il metodo specificati. Di solito, questa viene impostata per fare riferimento a unAWS::Serverless::Apirisorsa definita in questo modello.

Se non definisci questa proprietà,AWS SAMcrea un valore predefinitoAWS::Serverless::Apirisorsa che utilizza un prodotto generatoOpenApinon valido. Tale risorsa contiene un'unione di tutti i percorsi e i metodi definiti daApieventi nello stesso modello che non specificano unRestApiId.

Non è possibile fare riferimento aAWS::Serverless::Apirisorsa definita in un altro modello.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Esempi

Evento API

Un esempio di Api Event

YAML

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