SAM无服务器隐式API与AWS :: Serverless :: Api

Question

配置SAM模板并定义AWS::Serverless::Function有一个事件参数接受Api类型。 这是否会创建API网关资源？ 此事件类型与独立AWS::Serverless::Api资源之间有什么区别？

Answer 1

该问题询问SAM AWS :: Serverless :: Function类型的Event源块中引用的API，例如：

MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MyApi:
        Type: Api
        Properties:
          Path: /resource
          Method: GET

正如各个地方的文档中所提到的，这些在SAM中被称为“隐式API”。

SAM从AWS :: Serverless :: Function资源上定义的Api事件的并集创建AWS :: Serverless :: Api类型的资源 - 但仅限那些未引用（通过RestApiId属性）到AWS :: Serverless :: Api的资源在模板中明确定义。

在幕后，SAM收集所有这些隐式API，生成Swagger，并使用此Swagger创建隐式API。 此API默认为名为“Prod”的StageName，无法配置。

如果您确实需要控制在Swagger中定义和记录API，则应显式创建AWS :: Serverless :: Api资源。 然后会以这种方式引用它：

MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MyApi:
        Type: Api
        Properties:
          Path: /resource
          Method: GET
          RestApiId: !Ref MyAPI  # Add this line

MyApi:
  Type: AWS::Serverless::Api
  Properties:
    StageName: Prod
    DefinitionBody:
      ...

因此，它们之间的唯一区别在于您对其配置的控制程度，关键考虑因素是您是否需要定义：

• 艺名
• 一个Swagger定义（通过DefinitionBody）

如果您需要控制其中一个或两个，那么您需要明确定义您的API。 否则，您可以使用隐式API。

另请注意，SAM中的AWS :: Serverless :: Api资源被“转换”为AWS :: ApiGateway :: RestApi，AWS :: ApiGateway :: Stage和AWS :: ApiGateway :: Deployment类型的CloudFormation资源。

请注意，此信息是这三个源文档中的信息摘要：

• https://github.com/awslabs/serverless-application-model/blob/develop/versions/2016-10-31.md#awsserverlessapi
• https://github.com/awslabs/serverless-application-model/blob/master/docs/internals/generated_resources.rst#api
• https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst#implicit-apis

Answer 2

取自文档 ：

无需将AWS :: Serverless :: Api资源显式添加到AWS无服务器应用程序定义模板。 此类型的资源是从在模板中定义的AWS :: Serverless :: Function资源上定义的Api事件的并集隐式创建的，该资源不引用AWS :: Serverless :: Api资源。