/serverless-export-swagger

export the swagger definition of api gateway rest api created by serverless

Primary LanguageJavaScriptApache License 2.0Apache-2.0

serverless-export-swagger

serverless

A serverless plugin to automatically export Swagger definition of the RestAPi generated by serverless.

Install

npm install --save-dev serverless-export-swagger

Add the plugin to your serverless.yml file:

plugins:
  - serverless-export-swagger

Configuration

custom:
  swaggerDestinations:
    s3BucketName: 'bucket-name'
    s3KeyName: 'swagger/api.json'
    # optional, default: private
    acl: public-read