작업 노트 7-자바 에서 apidoc 문서 생 성 도구 등 간단 한 응용

더 읽 기
Apidoc 사용 설명서
간단 한 소개
프로젝트 개발 과정 에서 문서 생 성 도 구 를 사용 할 수 있 습 니 다. 이 도 구 는 Nodejs 모듈 입 니 다.사용 하기 전에 nodejs 환경 을 설치 하 십시오!
도구 이름:apiDoc Git 주소:https://github.com/apidoc/apidoc 항목 주소:http://apidocjs.com/ 샘플 항목:http://apidocjs.com/example_basic/ 
지원 하 는 주석 스타일: JavaDoc-Style
/**
 * This is a comment.
 */
apidoc 설치
명령 행 입력 
npm installapidoc –g
 
입력 apidoc–v
설치 성공 여 부 를 명령 으로 확인 합 니 다.
사용 방식
명령 줄 에 입력

apidoc -f ".*\\.js$" -f ".*\\.java$" -i myapp/ -o apidoc/ -t mytemplate/

 

参数说明： 
-f 文件过滤 
使用正则表达式，表示哪些文件需要本转换，不设置的情况下，默认为.cs .dart .erl .go .java .js .php .py .rb .ts 后缀的文件。

-i 代码文件夹

-o 输出Api文档的路径

-t 使用模板文件的路径，可以自定义输出的模板

       

我直接用的默认配置就行了         

       生成apidoc

       打开到你的项目路径下，命令行输入

       apidoc -o apidoc/

   生成文件里的index.html用浏览器打开就是文档啦

 

 

注释的定义自己到网上去找

   附上一些例子

 

   user.java

/**
 * @api {POST} /register     
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription       
 * @apiParam {String} account       
 * @apiParam {String} password   
 * @apiParam {String} mobile    
 * @apiParam {int} vip = 0      Vip   0      1 Vip  
 * @apiParam {String} [recommend]    
 * @apiParamExample {json}     ：
*                ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=
 * @apiSuccess (200) {String} msg   
 * @apiSuccess (200) {int} code 0       1     
 * @apiSuccessExample {json}     :
 *                {"code":"0","msg":"    "}
 */







 /**
 * @api {POST} /login     
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription       
 * @apiParam {String} userName    
 * @apiParam {String} password   
 * @apiParamExample {json}     ：
 *                ?userName=  &password=11223344
 * @apiSuccess (200) {String} msg   
 * @apiSuccess (200) {String} code 0       1     
 * @apiSuccess (200) {String} user     
 * @apiSuccess (200) {String} userId   id
 * @apiSuccessExample {json}     :
 *                {"code":"0","msg":"    ","userId":"fe6386d550bd434b8cd994b58c3f8075"}
 */






 /**
 * @api {GET} /users/:id       
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription       
 * @apiSuccess (200) {String} msg   
 * @apiSuccess (200) {int} code 0       1     
 * @apiSuccess (200) {String} name     
 * @apiSuccess (200) {String} mobile    
 * @apiSuccess (200) {String} birthday   
 * @apiSuccess (200) {String} email   
 * @apiSuccess (200) {String} summary   
 * @apiSuccess (200) {String} recommendCode      
 * @apiSuccess (200) {String} idCardNo     
 * @apiSuccess (200) {String} memberState      0     1VIP 2    
 * @apiSuccess (200) {String} address      
 * @apiSuccess (200) {String} money     
 * @apiSuccessExample {json}     :
 * {
 *   "code": 0,
 *   "msg": "",
 *   "name": "    ",
 *   "mobile": 15808544477,
 *   "birthday": "1990-03-05",
 *   "email": "[email protected]",
 *   "summary": "  ",
 *   "recommendCode": "     ",
 *   "idCardNo": "    ",
 *   "memberState": 1,
 *   "address": "    ",
 *   "money": "30.65"
 * }
 */







 /**
 * @api {POST} /users/:id   (  )    
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription   (  )    
 * @apiParam (200) {String} [name]     
 * @apiParam (200) {String} [mobile]    
 * @apiParam (200) {String} [birthday]   
 * @apiParam (200) {String} [email]   
 * @apiParam (200) {String} [summary]   
 * @apiParam (200) {String} [idCardNo]     
 * @apiParam (200) {String} [address]     
 * @apiSuccess (200) {String} msg   
 * @apiSuccess (200) {int} code 0       1     
 * @apiSuccessExample {json}     :
 *                {"code":"0","msg":"    "}
 */