openapicmd icon indicating copy to clipboard operation
openapicmd copied to clipboard

The CLI for all things OpenAPI and Swagger

OpenAPI Command Line Tool

CI License npm version npm downloads npm type definitions Buy me a coffee

openapicmd - The CLI for all things OpenAPI and Swagger

Install

npm install -g openapicmd
openapi help

Features

  • [x] Read and convert local and remote JSON/YAML OpenAPI definition files
  • [x] Generate TypeScript types from OpenAPI definitions
  • [x] Use as a CLI client to easily call API endpoints
  • [x] Run Local Mock APIs
  • [x] Automate API tests and validate specs
  • [x] Run Swagger UI or ReDoc locally
  • [x] Bundle static Swagger UI or ReDoc sites
  • [x] Run Swagger Editor locally
  • [x] Convert Swagger to OpenAPI

Commands

  • openapi help [COMMANDS]

openapi help [COMMANDS]

Display help for openapi.

USAGE
  $ openapi help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for openapi.

See code: @oclif/plugin-help

Commercial support

For assistance with using openapicmd in your company, reach out at [email protected].

Contributing

openapicmd is Free and Open Source Software. Issues and pull requests are more than welcome!