Skip to main content

Python library for Web APIs leveraging OpenAPI/Swagger specification

Project description

Python library for Web APIs leveraging OpenAPI/Swagger specification, enabling:

  • validation of an OAS 2.0 document

  • [todo] control backward compability between two OAS 2.0 documents

  • [todo] rewriting the basePath and paths of an OAS 2.0 document

  • [todo] filtering endpoints of an OAS 2.0 document to generate a subset of the API

  • [todo] adding/removing securityDefinitions on an OAS 2.0 document

Free software license: BSD 3-Clause License

Quickstart

Install oasapi from PyPI with:

pip install oasapi

You can also install the in-development version with:

pip install https://github.com/sdementen/oasapi/archive/master.zip

Validate an OAS 2.0 Document (in JSON or YAML format) with:

python -m oasapi validate path-to-a-swagger.json

or if you prefer with:

oasapi validate path-to-a-swagger.json

Documentation

https://oasapi.readthedocs.io/

Development

https://oasapi.readthedocs.io/en/latest/contributing.html#development

Changelog

0.1.6 (2019-01-08)

  • [dev] PyPI deployment through Travis CI

0.1.5 (2019-01-08)

  • Fix script form of the cli (oasapi instead of python -m oasapi)

0.1.4 (2019-01-08)

  • Explicit support only for python >= 3.6 (no py35 as use of f-string)

  • [dev] Move local build of docs from dist/docs to docs/dist to avoid cluttering dist

0.1.3 (2019-01-08)

  • [dev] Add git pre-commit hooks for black and flake

  • [dev] Do not use isort

  • [dev] Fix black + flake8 issues

0.1.2 (2019-01-08)

  • Fix model & reporting of duplicate operationIds

  • Add documentation on the CLI Usage

0.1.1 (2019-01-08)

  • Add pyyaml dependencies (to support OAS in yaml format)

0.1.0 (2019-01-08)

  • First release on PyPI.

  • Implementation of the validation of an OAS 2.0 (aka swagger) file

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

oasapi-0.1.6.tar.gz (30.5 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