by jamescooke

jamescooke / restapidocs

Templates for documenting REST APIs

264 Stars 895 Forks Last release: Not found The Unlicense 18 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.


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

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.