Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1.01 KB

README.md

File metadata and controls

21 lines (12 loc) · 1.01 KB

What is this?

This is a template repo that can be used to convert your Data Resource API descriptor files to swagger documentation by using this library.

At BrightHive we use the Data Resource API to stand up a live database and API from a declarative document.

These documents are called descriptors. This repo will convert your descriptor to an OpenAPI Specification 3.0 file that thoroughly documents your API.

Instructions

  1. git clone this repo.

  2. Ensure all of your API and table names are plural in your descriptor.

  3. Add your descriptor files to the descriptor folder.

  4. Run pipenv install.

  5. Run pipenv run python main.py

  6. A number of files will be produced; copy swagger.json and paste it into swaggerhub to make it pretty and convert it to YAML.

  7. Clean up the swagger file. There will be a lot of errors.