#readme-doc

在用koa写后端的时候，需要api文档便于与前端人员对接。

本工具让你可以更方便地自动生成restful api 文档 ， 支持：

1. 模版自定义
2. api文档模块
   • 数据库模型
   • 路由
   • 错误code

最佳实践： 建议结合git-hook在commit的时候执行本工具，达到提交的时候自动转换的效果。

下面是项目地址： Github 传送门

效果如何 ？？？？ ： 看看

#如何使用？ ###安装

$ npm install readme-doc --save-dev

###使用

$ cd /path/to/your/project
$ ./node_modules/.bin/readmedoc  init

你会在根目录中得到 README.template 文件 ，打开如下：

# Brief
### headers:
.
|        **name**         |       **value**       |
| :-----------------      | :-------------------: |
|  x-authorization-token  |          token        |
|  x-app-platform         |     web , web-admin   |
|  x-app-error            |     true , false      |
.
### querys:
-
|        **name**         |       **detail**       |
| :-----------------      | :-------------------: |
|        sort             |          排序           |
|        limit            |       限制返回数量（分页） |
|        skip             |       跳过返回数量（分页） |
.
<!- errors /test/data/exception.js ->
.
<!- models /test/data/models ->
.
<!- routes /test/data/routes.js ->

可以调整内容的位置，修改路径等

一切修改完以后，开始进行转化：

$ ./node_modules/.bin/readmedoc gen

回头看看README.MD , 会生成一份api 文档，如遇到问题，欢迎issues

License

MIT