https://github.com/jamescooke/restapidocs
Templates for documenting REST APIs
https://github.com/jamescooke/restapidocs
documentation markdown rest-api
Last synced: about 20 hours ago
JSON representation
Templates for documenting REST APIs
- Host: GitHub
- URL: https://github.com/jamescooke/restapidocs
- Owner: jamescooke
- License: unlicense
- Created: 2015-07-23T21:37:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T16:39:02.000Z (about 4 years ago)
- Last Synced: 2024-04-16T07:32:00.996Z (about 1 year ago)
- Topics: documentation, markdown, rest-api
- Homepage:
- Size: 14.6 KB
- Stars: 512
- Watchers: 12
- Forks: 1,527
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-api-documentation-tools - API Documentation Template - Template for REST API documentation. (Documentation Templates)
- awesome-api-documentation-tools - API Documentation Template - Template for REST API documentation. (Documentation Templates)
README
# REST API Documentation Templates
## In Markdown
Inspired by [@iros](https://github.com/iros)'s [documentation
gist](https://gist.github.com/iros/3426278).
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](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](http://unlicense.org/), spread the word.