首页 » Windows » apidoc for windows

apidoc for windows

原文 http://blog.csdn.net/qq_26712449/article/details/79147825

2018-01-25 02:02:00阅读(467)

下载64位的nodejs:
https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi
windows中安装;
在cmd中执行命令安装apidoc

 npm install -g apidoc

apidoc <a href=for windows" title="" alt="这里写图片描述" src="http://img.blog.csdn.net/20180124101708575?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvcXFfMjY3MTI0NDk=/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast">

在需要生成的目录下新建一个apidoc.json

{   
  "name": "example",   
  "version": "0.1.0",   
  "description": "example",  
  "title": "title",   
  "url" : "http://www.test.com 

在这里新建一个java文件:

/**
 * @api {post} /user 中文
 * @apiName obj
 * @apiParam {Object} person 
 * @apiParam {String} person.name  姓名 
 * @apiParam {Integer} person.age 年龄 
 */

在windows中cmd中使用cd切换到生成doc的目录文档;执行apidoc生成文档。

apidoc参数:

参数 描述 -i 选择源代码所在位置 -o 选择生成的目标文件所在的位置

常用:

apidoc -i com/src/ -o out/
apidoc -h

apidoc.json中常见的配置项:
- name 工程名
- version 工程文档的版本号
- description 工程详细描述
- title 文档标题
- url 整个api url的前缀

最新发布

CentOS专题

关于本站

5ibc.net旗下博客站精品博文小部分原创、大部分从互联网收集整理。尊重作者版权、传播精品博文,让更多编程爱好者知晓!

小提示

按 Ctrl+D 键,
把本文加入收藏夹