Skip to main content

openapi cli tool

Project description

openapi-cli-tool

Build Status

openapi-cli-tool

OpenAPI (Swagger 3.x) CLI Tool.

  • Supports multiple file extensions (json|yaml|yml).
  • Can list up defined API paths.
  • Display an API specification which is resolved ($ref).
  • Bundle multi-file into one (output to json|yaml|html).
  • OAS interactive scaffolding.

Requirements

Python 2.7, 3.4 <=.

Installation

With pip:

$ pip install openapi-cli-tool

Manually:
Clone the repository and execute the Python installation command on your machine.

$ pip -r requirements.txt install
$ python setup.py install

Then openapi-cli-tool command is installed.

Usage

$ openapi-cli-tool --help
Usage: openapi-cli-tool [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  bundle    Bundle multiple files into one.
  list      List up API paths in a file or directory.
  resolve   Display `$ref` resolved API specification.
  scaffold  Interactively create a simple OpenAPI Specification.

Bundle

Bundle multi-file specifications into one, regardless of file extension (json|yaml|yml).

$ openapi-cli-tool bundle --help
Usage: openapi-cli-tool bundle [OPTIONS] FILE_PATHS

  Bundle multiple files into one.

Options:
  -f, --file TEXT  Load common objects such as info and servers from a
                   specific file. Default is a file which is the top of list
                   command result.
  -t, --type TEXT  Export data type. {json|yaml|html}  [default: json]
  --help           Show this message and exit.

example:

$ openapi-cli-tool bundle -t html file1.json file2.yaml` > ./specification.html

In the html file, an unpkg version of swagger-ui is embedded. Rendered screenshot below:

bundle-html-img

List

List up API paths from a file/directory regardless of the file extension (json|yaml|yml).

$ openapi-cli-tool list `find ./spec`

Method    Path       File
--------  ---------  ------------------------------------------
PUT       /avatar    ./tests/resources/spec/sample.yml
GET       /follwers  ./tests/resources/spec/folder1/sample2.yaml
POST      /follwers  ./tests/resources/spec/folder1/sample2.yaml
PUT       /follwers  ./tests/resources/spec/folder1/sample2.yaml
POST      /pets      ./tests/resources/spec/sample.yml
GET       /posts     ./tests/resources/spec/folder1/sample.json
POST      /posts     ./tests/resources/spec/folder1/sample.json
GET       /users     ./tests/resources/spec/folder1/sample.json
POST      /users     ./tests/resources/spec/folder1/sample.json

Resolve

Display an API specification which is resolved from a multi-file API specification via $ref pointers.

Usage: openapi-cli-tool resolve [OPTIONS] METHOD PATH FILE_PATHS

  Display `$ref` resolved API specification.

Options:
  -t, --type TEXT  Export data type. {json|yaml}  [default: json]
  --help           Show this message and exit.

example:

$ openapi-cli-tool resolve post /cats `find ./tests/resources/spec`

Scaffold

Interactively input information of your API.
A simple OpenAPI Specification is generated from your prompt.

$ openapi-cli-tool scaffold

Please enter title [""]: sample
Please enter version [v1.0]:
Please enter license [Apache 2.0]:
Please enter server url [http://example.com]:
Please enter path [/]: /example
Please enter method for /example [get|post|put|delete|head|option|trace]: get
Please enter description for get /example [""]: sample get endpoint
Please enter response code for get /example [200]:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi-cli-tool-0.2.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distributions

openapi_cli_tool-0.2.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

openapi_cli_tool-0.2.1-py2-none-any.whl (10.5 kB view details)

Uploaded Python 2

File details

Details for the file openapi-cli-tool-0.2.1.tar.gz.

File metadata

  • Download URL: openapi-cli-tool-0.2.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.15

File hashes

Hashes for openapi-cli-tool-0.2.1.tar.gz
Algorithm Hash digest
SHA256 502c2d0b5463062859ae6f02de4e030c097073cc4e1bc54caffc7e7e847379a9
MD5 35ff85bf1c37f2b9f9295038ad0232e1
BLAKE2b-256 9ea9795f8731dbfd065f080c232a68762efd61a75a8b3ffea45dbb979043e585

See more details on using hashes here.

File details

Details for the file openapi_cli_tool-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: openapi_cli_tool-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.6

File hashes

Hashes for openapi_cli_tool-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b142eb68bfa032d6daba48c93ad9db5c950ee2b8948afed7c03c5dcbcc2ac88
MD5 301494447b86971ba0c69a3fdfb691ce
BLAKE2b-256 c92a94e57accaedf1db779267138a16f44dbfd2b16fab5fd0466c8eb80343a1a

See more details on using hashes here.

File details

Details for the file openapi_cli_tool-0.2.1-py2-none-any.whl.

File metadata

  • Download URL: openapi_cli_tool-0.2.1-py2-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.15

File hashes

Hashes for openapi_cli_tool-0.2.1-py2-none-any.whl
Algorithm Hash digest
SHA256 d7049cd442add6f64c2db6dfc89699653a0177f50a390fe8af4c61f0b6a9c95b
MD5 0c04bea506663b41b81a1a1e9d76f060
BLAKE2b-256 51c2fc3af6ba26310d96a0a38623e20ab9c57c147692c085893452472006da8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page