zoukankan      html  css  js  c++  java
  • apiDoc 入门

    网站

    http://apidocjs.com/#demo

     

    Install

    npm install apidoc -g

    Run

    apidoc -i myapp/ -o apidoc/ -t mytemplate/
    没有模板
    apidoc -i myapp/ -o apidoc/
    
    

    Demo

    首先要有个myapp文件夹

    里面有一个接口描述( 详细描述见官网 )

     /** 
     * @api {post} /company/useList 获取公司员工列表
     * @apiName PostCompany
     * @apiGroup User
     * @apiVersion 0.1.0
     * @apiDescription 接口详细描述
     * 
     * @apiParam {int} pageNum分页大小 
     * 
     * @apiSuccess {String} code 结果码
     * @apiSuccess {String} msg 消息说明
     * @apiSuccess {Object} data 分页数据封装
     * @apiSuccess {int} data.count 总记录数
     * @apiSuccess {Object[]} data.list 分页数据对象数组
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *  
     *  @apiError All 对应<code>id</code>的用户没找到 asdfasdf 
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *   
     */
    
     /** 
     * @api {get} /company/useList 获取公司员工列表
     * @apiName GetCompany
     * @apiGroup User
     * @apiVersion 0.1.0
     * @apiDescription 接口详细描述
     * 
     * @apiParam {int} pageNum分页大小 
     * 
     * @apiSuccess {String} code 结果码
     * @apiSuccess {String} msg 消息说明
     * @apiSuccess {Object} data 分页数据封装
     * @apiSuccess {int} data.count 总记录数
     * @apiSuccess {Object[]} data.list 分页数据对象数组
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     * code:0,
     * msg:'success',
     * data:{}
     *  }
     *  
     *  @apiError All 对应<code>id</code>的用户没找到 asdfasdf 
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *   code:1,
     *   msg:'user not found',
     *   }
     *   
     */

    运行

    
    
    apidoc -i myapp/ -o apidoc/

    会生成一个文件夹apidoc,里面就是生成的接口页面
     
  • 相关阅读:
    团队项目-第一阶段冲刺2
    团队项目-第一阶段冲刺1
    第九周总结
    梦断代码阅读笔记02
    第八周总结
    团队会议个人领取任务
    梦断代码阅读笔记01
    Spring Boot 揭秘与实战(二) 数据缓存篇
    Spring Boot 揭秘与实战(二) 数据缓存篇
    Spring Boot 揭秘与实战(二) 数据缓存篇
  • 原文地址:https://www.cnblogs.com/yang-C-J/p/7504825.html
Copyright © 2011-2022 走看看