randomly generated API key is not displayed if no API key is defined

[christophgysin]

Currently, serverless-offline checks if there is a apiKeys: section to decide if the randomly generated API key should be logged.

If we have a service that defines http events as private: true, but not define apiKeys, the generated API key is not logged.

frameworkVersion: '>=1.55.1 <2.0.0'
service: private
plugins:
  - serverless-offline
provider:
  name: aws
  runtime: nodejs10.x
functions:
  private:
    handler: private.handler
    events:
      - http:
          path: /private
          method: get
          private: true

$ npx sls offline
Serverless: Starting Offline: dev/us-east-1.

Serverless: Routes for private:

One workaround is to define an empty list of apiKeys:

provider:
  apiKeys: []

$ npx sls offline
Serverless: Starting Offline: dev/us-east-1.
Serverless: Key with token: sad8hj23f08werjf09sdfjv923v
Serverless: Remember to use x-api-key on the request headers

A better solution would be to check if there are any http events with private: true.

[dnalborczyk]

hey @christophgysin thanks for opening this issue. I'm unfamiliar with private endpoints, nonetheless, it seems that private endpoints don't require api keys.

[christophgysin]

Setting private: true is the serverless way of configuring an endpoint to require an API key. See:
https://serverless.com/framework/docs/providers/aws/events/apigateway/#setting-api-keys-for-your-rest-api

[dnalborczyk]

thank you for the link @christophgysin ! I'll have a look into your issue and the PR soon.

[dnalborczyk]

PR merged. closing.