项目作者: jamescooke

项目描述 :
Templates for documenting REST APIs
高级语言:
项目地址: git://github.com/jamescooke/restapidocs.git
创建时间: 2015-07-23T21:37:07Z
项目社区:https://github.com/jamescooke/restapidocs

开源协议:The Unlicense

下载


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.