Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 1.12 KB

README.md

File metadata and controls

47 lines (25 loc) · 1.12 KB

OpenCLI

A CLI for every service which exposes a OpenAPI (Swagger) specification endpoint.

From the OpenAPI Specification project:

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

Demo

Alt Text

Docker

To start a CLI session run:

docker run -it sharbov/open-cli <swagger-spec-url>

e.g:

docker run -it sharbov/open-cli http://petstore.swagger.io/v2/swagger.json

Python

Installation

To install OpenCLI, simply:

pip install opencli

Usage

To start a CLI session run:

open-cli <swagger-spec-url>

e.g:

open-cli http://petstore.swagger.io/v2/swagger.json

For more options run:

open-cli -h

Credits

This project relies on Yelps bravado project & on Jonathan Slenders python-prompt-toolkit.