An example of Github Wiki containing API documentation. This is meant to be used as a template for documenting an API, or as an exercise for helping to think out API details. Well this template is probably best fit for REST style APIs, feel free to modify it however you see fit.
To get see how this template is laid out, take a look at the API Documentation Template Wiki. However, keep in mind that nothing in this template is required and that some pieces may not even make sense in the context of certain APIs.
All of that said, if you're new to documenting APIs, have a large API, or are looking for a long term solution, be aware that something like this may not be the ideal. Investigating projects such as Swagger and I/O Docs. may be prove to be worthwhile.
#Cloning If you'd like to clone a copy of this wiki, it can be done with the following command.
git clone https://github.com/bunchopunch/API-Documentation-Template.wiki.git