Skip to content

yyeh26/restapidocs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 

Repository files navigation

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.

About

Templates for documenting REST APIs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published