Skip to main content

A python package which converts apidoc comments in various languages to OpenApi Spec .json files.

Project description

Apidoc to Openapi Converter   guide

Apidoc syntax is very easy and lightweight, whereas Openapi aka Swagger syntax is very verbose and not noob friendly. The goal of this project is to make documenting api endpoints so easy that developers won't mind spending the time to do it, instead of just ignoring documentation.

Apidoc conversion coverage

Convertable Annotations:

@api
@apiName
@apiGroup
@apiParam
@apiSuccess

Feel free to PR in any other annotations you need.

Installing

pip install apidoc-to-openapi
usage: apidoc_to_openapi [-h] -i path [-o path] [--yaml]

optional arguments:
  -h, --help  show this help message and exit
  -o path     File output (default: stdout)
  --yaml      Convert output to yaml format

Required:
  -i path     File or directory containing apidoc annotations

Example

apidoc-to-openapi -i ./my/path/ -o ./my/path/swagger.yaml --yaml

Running the tests

Used pytest for testing. Test coverage isn't near where I want it to be.

Coding Style

Using black formatter and pylint

Authors

  • Graham Thomas - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • I have no friends

Project details


Download files

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

Files for apidoc-to-openapi, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size apidoc_to_openapi-0.0.2-py3-none-any.whl (15.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size apidoc_to_openapi-0.0.2.tar.gz (8.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page