Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search Sign up Reseting focus

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Templates for documenting REST APIs

License

Notifications You must be signed in to change notification settings

jamescooke/restapidocs

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Go to file

Folders and files

Last commit message Last commit date

Latest commit

History

View all files

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

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.