apidoc 工具的使用

使用rest framerok时，需要写API接口文档，此时就需要用到 apidoc(个人觉得这个用的比较顺手)

需要安装nodejs,,,

windows 下

　　1 然后验证是否安装成功  node -v

　　2 安装完nodejs环境后，会自带npm,npm为nodejs包管理工具，安装apidoc :npm install apidoc -g,

　　　　 安装完成后，使用apidoc -h,查看是否安装成功

　　3  C:\nodejs\ex>apidoc -i c://nodejs/ex/ -o apidoc/   [使用，apidoc.json一定要放在同级目录]

　　

 

 

{
  "name": "apidoc-example",
  "version": "0.3.0",
  "description": "apiDoc example project",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

View Code---apidoc.json内容