Skip to main content

Generate client based on OpenAPI Specification and wrap it in a command line interface

Project description

# 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](https://github.com/sharbov/open-cli/blob/master/demo.gif)

## 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](https://github.com/Yelp/bravado) project & on Jonathan Slenders [python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit).

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

opencli-0.0.9.tar.gz (101.9 kB view hashes)

Uploaded Source

Supported by

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