serverless-plugin-swagger-ui

A serverless plugin to build Swagger UI static site

Installation

npm install --save-dev serverless-plugin-swagger-ui
# or
yarn add --dev serverless-plugin-swagger-ui

Configuration

plugins:
  - serverless-plugin-swagger-ui

custom:
  swaggerUi:
    # [Optional] The name of S3 bucket to serve Swagger UI static site. If you set the S3 bucket name, this plugin will upload documentation files to the S3 bucket.
    s3Bucket: 'default is undefined'
    #  [Optional] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
    exportType: oas30 # default value
    # [Optional] The content-type of the export. Currently application/json and application/yaml are supported for exportType of oas30 and swagger.
    accepts: application/yaml # default value
    # [Optional] For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool.
    extensions: integrations # default value
    # [Optional] The name of local directory to build Swagger UI static site
    swaggerUiDirectoryName: .swagger-ui # default value
    # [Optional] Swagger UI configuration. See https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ . 'configUrl' and 'url' will be ignored.
    swaggerUiConfig: # default value is the below
      dom_id: '#swagger-ui'
      deepLinking: true
      presets:
        - SwaggerUIBundle.presets.apis
        - SwaggerUIStandalonePreset
      plugins:
        - SwaggerUIBundle.plugins.DownloadUrl
      layout:
        - StandaloneLayout

See example.

Usage

To build Swagger UI static site after deploy:

serverless deploy

To build Swagger UI static site:

serverless swaggerUi

License

MIT © kobanyan