Generate Markdown from an openapi JSON file.
Project description
OpenAPI Readme Generator
Generates Markdown suitable for a README file from a local openapi.json
file.
This tool is still under development, progress so far is only a days work so there is a lot to do with extra functionality and refactoring.
Usage
openapi-readme [OPTIONS]
Run this in the same directory as your openapi.json
file. By default the
Markdown output will be printed to the console, but you can redirect it out to
a file too.
The particular styling of the generated Markdown is currently hardcoded, though plans are afoot to implement some sort of themeing.
Options Summary
--route-level INTEGER
: Number of heading levels to use. [default: 4]--inject / --no-inject
: Inject generated output into a README file. [default: False]--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Options in Detail
--route-level
Specify the heading level for each Route in the generated documentation. This defaults to 4 if not specified, ie:
#### **`GET`** _/user/list_
--inject
Injects the new Markdown directly into a README.md
file in the current
directory, if it is found.
You need to add the placeholder comment <!-- openapi-schema -->
to your markdown where you want it to be injected:
This is some preceeding text
### API Schema description
<!-- openapi-schema -->
### Next section
The document continues unaffected after the injection.
Existing (previously injected) Schemas will be replaced by this new data.
TODO
Future improvement plans
- Take more info from the
openapi.json
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
Built Distribution
Hashes for openapi_readme-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d78470cfeeca8a9a84d4ffd1543895c541ed3c0095db9dca75b9d0f882116bbe |
|
MD5 | 61ba244a0d266223e720edb37c78a9da |
|
BLAKE2b-256 | c345f348270a47bcd0432dc3d86f2fea0ae0248c7b1f6fbf368524bebda85d67 |