JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 130
  • Score
    100M100P100Q68697F
  • License Apache 2.0

Command line tool for generating OpenAPI spec and SwaggerUI from AWS API Gateway

Package Exports

  • apig-swagger-ui

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (apig-swagger-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

apig-swagger-ui

Command line tool for generating OpenAPI spec and SwaggerUI from AWS API Gateway

oclif Version Downloads/week License

Typical usage:

$ npx apig-swagger-ui -r ap-southeast-2 -s
npx: installed 92 in 9.635s
Generating files to: api-doc
Generating OpenAPI spec for: https://api.dev1.insights.example.domain.com/analytics
Generating OpenAPI spec for: https://boi.uat1.env.example.domain.com/statement
Generating OpenAPI spec for: https://catalog.tst1.env.example.domain.com/
Generating OpenAPI spec for: https://cis.uat1.env.example.domain.com/
Generating OpenAPI spec for: https://leads.uat1.env.example.domain.com/v2
Generating OpenAPI spec for: https://leads.uat1.env.example.domain.com/inbound
Generating OpenAPI spec for: https://rulehub.uat1.env.example.domain.com/citizenship
Generating OpenAPI spec for: https://toggle-feature-flag-datadog.uat1.env.example.domain.com/
Generating OpenAPI spec for: https://v1pde.uat1.env.example.domain.com/key
Local server started. Ctrl-C to stop. Access URL: http://localhost:8001/

You can use --include and --exclude flags to specify which domain/path to include and which to exclude.

Usage

$ npm install -g apig-swagger-ui
$ apig-swagger-ui COMMAND
running command...
$ apig-swagger-ui (-v|--version|version)
apig-swagger-ui/1.0.2 darwin-x64 node-v12.18.2
$ apig-swagger-ui --help [COMMAND]
USAGE
  $ apig-swagger-ui COMMAND
...

Commands