This repository forked from restapidocs that created by jamescooke.
The author of the repository inspired by @iros's documentation gist.
Focus on using the templating Markdown to create comprehensive, structured and helpful API documentation. Structure should be regular and repeated across endpoints and between projects.
This forked template was improved by using a tree list and also added emoji for easy viewing of the details or attributes of the endpoint API. The requests and responses are grouped in each perspective. The responses were also grouped by the error and success responses.
In a brief way, here is what's makes this endpoint API template different from the original one:
- Use the tree list and emojis to view the details and attributes.
- grouped the requests and responses
- grouped the error and success responses.
All templates are provided by example:
- Examples - For each template, a completed anonymised example. Where possible this example comes from a real project.
The code in this repository is not licensed in any way.
Do what you want, Unlicense dot org, spread the word.