Skip to content
This repository has been archived by the owner on May 19, 2020. It is now read-only.

Latest commit

 

History

History
16 lines (10 loc) · 768 Bytes

README.md

File metadata and controls

16 lines (10 loc) · 768 Bytes

shinola

Shins-as-a-service. Generate beautiful Shins Slate-compatible API documentation on the fly, from markdown or OpenApi / Swagger definitions

logo

Deploy

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