Skip to content

pedrocatre/API-Doc-Generator

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

API Doc Generator

A backbone web app that builds a human readable version of JSON documentation dynamically created by a company's framework. This was part of a small exercise that was given to me. You can check out the result here.

It presents a list of resources that you can expand to view the operations/interfaces. You can also expand the operations one at a time or use the controls over the resource to list all operations or expand all operations.

Also when you click to view a resource and/or interface the URL updates so you can bookmark a specific position. For example you can have a link to the Customers resource or a link to the Products' update_product interface.

The design is heavily based on swagger :)

About

A backbone web app that builds a human readable version of JSON documentation dynamically created by a company's framework.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published