Laravel

Laravel中使用apiDoc生成接口文档 (一)

文 / 管理员 来源 / 原创 阅读 / 606 3年前

apidoc官方文档:http://apidocjs.com/#params

第一步:使用:npm install apidoc -g
命令安装apidoc。
第二步:在项目根目录下新建apidoc.json文件,文件内容格式参考如下:

{    
    "name": "laravel-api-demo",    
    "version": "1.0.0",    
    "description": "LARAVEL API DEMO",    
    "title": "laravel api demo",    
    "url" : "http://localhost/apidoc/"
}

如图:

image.png


第三步:在控制器添加以下代码

/**
 * @api {post} /authorizations 创建一个token (create a token)
 * @apiDescription 创建一个token (create a token)
 * @apiGroup Auth
 * @apiPermission none
 * @apiParam {Email} email     邮箱
 * @apiParam {String} password  密码
 * @apiVersion 0.2.0
 * @apiSuccessExample {json} Success-Response:
 *     HTTP/1.1 201 Created
 *     {
 *         "data": {
 *             "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHmnd2aUr4IVM9rm2Wchxg5RX_SDpM",
 *             "expired_at": "2017-03-10 15:28:13",
 *             "refresh_expired_at": "2017-01-23 15:28:13"
 *         }
 *     }
 * @apiErrorExample {json} Error-Response:
 *     HTTP/1.1 401
 *     {
 *       "error": "用户面密码错误"
 *     }
 */


第四步:执行生成命令(生成位置:public/apidoc

apidoc -i App/Http/Controllers/ -o public/apidoc/

命令行解释

使用apidoc -i myapp/ -o apidoc/ -t mytemplate/"

其中:
-i 表示输入,后面是文件夹路径
-o 表示输出,后面是文件夹路径
默认会带上-c,在当前路径下寻找配置文件(apidoc.json),如果找不到则会在package.json中寻找 "apidoc": { }
myapp/ 表示要生成api的源文档所在目录位置
mytemplete/ 表示要生成api到的目录位置

Laravel中使用apiDoc生成接口文档


执行完命令行之后,生成下图

Laravel中使用apiDoc生成接口文档


第五步:访问文档    http://服务器地址/apidoc

Laravel中使用apiDoc生成接口文档



具体使用教程:

Laravel中使用apiDoc生成接口文 档(二)


评论

共0条评论
  • 这篇文章还没有收到评论,赶紧来抢沙发吧~

站点声明:本站转载作品版权归原作者及来源网站所有,原创内容作品版权归作者所有,任何内容转载、商业用途等均须联系原作者并注明来源。

© 2020-2030 qdxcy.cn 版权所有京ICP备13045222号
相关侵权、举报、投诉及建议等,请发E-mail:2323946929@qq.com

友情链接: YzmCMS官方网站 YzmCMS官方论坛