Skip to content

Shins-as-a-service. Generate Shins/Slate API documentation on the fly

License

Notifications You must be signed in to change notification settings

copongcopong/shinola

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:https://shinola.herokuapp.com/shins?url=http:https://url.to.markdown.md
  • http:https://shinola.herokuapp.com/openapi?url=http:https://url.to.openapi.json-or-yaml
  • http:https://shinola.herokuapp.com/openapi?url=http:https://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

About

Shins-as-a-service. Generate Shins/Slate API documentation on the fly

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 96.7%
  • HTML 3.3%