shinola
v1.0.1
Published
shins-as-a-service
Downloads
3
Maintainers
Readme
shinola
Shins-as-a-service. Generate beautiful Shins Slate-compatible API documentation on the fly, from markdown or OpenApi / Swagger definitions
Then connect and submit a request like:
http://shinola.herokuapp.com/shins?url=http://url.to.markdown.md
http://shinola.herokuapp.com/openapi?url=http://url.to.openapi.json-or-yaml
http://shinola.herokuapp.com/openapi?url=http://url.to.openapi.json-or-yaml&raw=true
The last call returns the converted markdown, not the rendered HTML.
The server runs by default on port 5678 or as specified in the PORT
environment variable