Skip to content

Need to put this somewhere so people can read it over and try out the various documentation formats

Notifications You must be signed in to change notification settings

jbuckle/swagger_sandbox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Sample application, exists to demo the presentation layer of V4 and the documentation that that presentation layer would output.

View Redoc Documentation

Start the rails server on port 3005 and navigate to localhost:3005/redoc_index.html.

View Swagger-UI documentation

Swagger-ui is unfortunately more of a pain to get started. You have to clone the swagger-ui project from github and then open the file ~/swagger-ui/dist/index.html in your web browser. With the rails server running, change the URL in the top text input to be "http://localhost:3005/api/swagger_doc.json." You should see the docs for this project appear.

View Presentation Layer

Presenters are inside app/presenters, and all subclass app/presenter/presenter.rb.

About

Need to put this somewhere so people can read it over and try out the various documentation formats

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published