README

介绍

laravel文档生成工具。

软件架构

利用php的反射生成的api文档数据。

1.安装教程

composer require safi16/laravel-api-doc-tools
php artisan vendor:publish --provider="Safi16\LaravelApiDoc\Providers\ApiDocServiceProvider" --tag=config

2.控制器注解-规范

/**
 * @Name("公共");
 * @Order("0");
 * @GroupMiddleware("api|auth:sysUserGuard");       
 */
 
 Name           分组-名称
 Order          分组-排序,如果重复会加一个(10000,20000)随机数
 GroupMiddleware     所用到的中间件(app/Http/Kernel.php=>$middlewareGroups): "api"=>单个中间件,"auth:devUserGuard|refresh_token"=>多个中间件,多个用"|"分隔开

3.单方法参数,例子

/**
 * @Name("登录");
 * @Author("Sifa");
 * @Parameters([
 *      @Parameter(["field"=>"username","name"=>"用户名","value"=>"liuxh", "type"=>"string", "required"=>true, "description"=>"手机号码","validation"=>"string|min:2|max:20"]),
 *      @Parameter(["field"=>"password","name"=>"密码","value"=>"123333", "type"=>"string", "required"=>true, "description"=>"验证码,必须是6位","validation"=>"string|min:6"])
 * ]);
 * @Response([
 *      @success('{
 *              "re_code": 0,
 *              "re_result": {
 *                      "money": "1000.00",                                   // 用户账户余额
 *                      "icon": "http://wx.qlogo.cn/mmopen/PiajxS....",       // 用户头像
 *                      "nickname": "张三"                                    // 昵称
 *              }
 *           }'),
 *      @error('{
 *              "re_code": 1,
 *              "re_message": "验证码错误"
 *           }')
 * ]);
 * @Tip("");
 * @Middleware("throttle:600,1|refresh_token");
 */

 Name           api接口名称
 Author         作者
 Parameters     请求参数
    Parameter       单条请求参数
        name            参数-名称
        field           参数-键值
        value           参数-值
        type            类型: object=>json对象数据,  非object=>常规数据
        required        是否必须
        required        是否必须
        description     描述
        validation      字段验证规则: validation"=>"string|min:2|max:20
 Response       响应参数
    success         成功
    error           失败
 Tip			提示信息
 Middleware		中间件数组，如: throttle:600,1|refresh_token，多个用"|"分隔开

safi16 / laravel-api-doc

Maintainers

Details

README

介绍

软件架构

1.安装教程

2.控制器注解-规范

3.单方法参数,例子