Templates for documenting REST APIs
Switch branches/tags
Nothing to show
Clone or download
Latest commit b7fc5f6 Jun 8, 2016

README.md

REST API Documentation Templates

In Markdown

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.

By example

All templates are provided by example:

  • Examples - For each template, a completed anonymised example. Where possible this example comes from a real project.

Free

The code in this repository is not licensed in any way.

Do what you want, Unlicense dot org, spread the word.