serverless.yml

service: node-aws-lambda-example-hello-world

plugins:
  - serverless-domain-manager
  - serverless-v2-aws-documentation
  - serverless-jetpack
  - serverless-offline

provider:
  name: aws
  runtime: nodejs20.x
  memorySize: 512
  profile: serverless
  stage: dev
  region: us-east-1

  lambdaHashingVersion: 20201221

  logs:
    restApi: true

  tracing:
    apiGateway: true
    lambda: true

  environment:
    DEBUG: ${self:custom.environment.debugLog}
    NODE_ENV: ${self:custom.environment.nodeEnvironment}

custom:
  stage: ${opt:stage, self:provider.stage}
  region: ${opt:region, self:provider.region}

  domainName: ${self:custom.domainNameStage.${self:custom.stage}}
  domainNameStage:
    dev: 'localhost:${self:custom.serverless-offline.httpPort}'
    test: test-api.${self:custom.baseDomainName}
    prod: api.${self:custom.baseDomainName}
  baseDomainName: codesaplings.com
  customDomain:
    domainName: ${self:custom.domainName}
    certificateName: ${self:custom.domainName}
    basePath: hello
    stage: ${self:custom.stage}
    createRoute53Record: true

  serverless-offline:
    httpPort: '3000'
    websocketPort: '3001'
    lambdaPort: '3002'

  environment:
    debugLog: ${self:custom.environment.debugLogStage.${self:custom.stage}}
    debugLogStage:
      dev: 'sapling-hello-world:*,-*:trace'
      test: 'sapling-hello-world:*,-*:trace'
      prod: 'sapling-hello-world:*,-*:trace'
    nodeEnvironment: ${self:custom.environment.nodeEnvironmentStage.${self:custom.stage}}
    nodeEnvironmentStage:
      dev: development
      test: test
      prod: production

  documentation:
    info:
      title: Hello World!
      description: Simple function to return a nice message
      version: 1.0.0
    models:
      - name: DataInput
        description: Data input for the application
        contentType: application/json
        schema:
          type: object
          properties:
            word:
              type: string
              description: Word to be used in the message

      - name: DataOutput
        description: Response message
        contentType: application/json
        schema:
          type: string

      - name: ErrorResponse
        description: Error response from the application
        contentType: application/json
        schema:
          type: object
          properties:
            error:
              type: string
              description: Error message

package:
  individually: false

  exclude:
    - .circleci/**
    - .github/**
    - .idea/**
    - .env*
    - examples/**
    - scripts/**
    - spec/**
    - tmp/**
    - '**/node_modules/aws-sdk/**'

functions:
  helloWorld:
    handler: dist/events/helloWorld.handler
    events:
      - http:
          path: /
          method: get
          cors: true
          documentation:
            summary: Get a hello message
            description: Returns a JSON string with a nice message
            queryParams:
              - name: word
                in: query
                description: A word to use in the message
                required: false
                type: string
            methodResponses:
              - statusCode: '200'
                responseBody:
                  description: Successful operation
                responseModels:
                  'application/json': DataOutput
              - statusCode: '400'
                responseBody:
                  description: Invalid input provided
                responseModels:
                  'application/json': ErrorResponse
              - statusCode: '500'
                responseBody:
                  description: Unhandled error
                responseModels:
                  'application/json': ErrorResponse

      - http:
          path: /
          method: post
          cors: true
          documentation:
            summary: Produce a hello message
            description: Returns a JSON string with a nice message
            requestModels:
              'application/json': DataInput
            methodResponses:
              - statusCode: '200'
                responseBody:
                  description: Successful operation
                responseModels:
                  'application/json': DataOutput
              - statusCode: '400'
                responseBody:
                  description: Invalid input provided
                responseModels:
                  'application/json': ErrorResponse
              - statusCode: '500'
                responseBody:
                  description: Unhandled error
                responseModels:
                  'application/json': ErrorResponse