个人写的一个小工具 laravel生成接口文档

laravel-doc安装

  • 写文档非常浪费后端同学的时间

  • 自动读取 request 的验证规则和方法注释作为请求参数

  • 读取attributes,validation.php,数据库字段字段作为注释

  • 提供中间件保存返回会自动的生成相关文档

  1. 安装

      composer require faed/laravle-doc 
  2. 发布配置

      php artisan vendor:publish 
  3. 配置

    return [ //版本
      'v'=>1,
    //名称
      'name'=>env('APP_NAME'),
    //app名称
      'app_name'=>env('APP_NAME'),
    //请求地址
      'path'=>env('APP_URL'),
    //接口地址发送地址
      'send'=>'http://127.0.0.1:8000',
    //路由过滤
      'only'=>'api',
    //laravle版本 7.8路由方式不一样默认8请自行定义
      'laravle_versions'=>8,
    //自动读取数据库的字段注释作为注释,多库请自行定义
      'mysql' => ['mysql'],
    ];    
  4. 运行迁移文件生成相关的表

      php artisan migrate  
  5. 运行 自动生成相关的文档数据路由 xxxxx/doc

      php artisan api:make 

    文档编写

类注释自动分组,控制器

/**
 * @group 接口
 * @package App\Http\Controllers */
/**
 * 说明
 * @q size Y 大小
 * @u page N 分页
 * @b body Y 参数
 */

使用

  1. xxxxx/doc 路由

image

image

  1. 提供中间件[ RecordReturn ]记录返回数据,请自行添加

      [
            'throttle:api',
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
            RecordReturn::class,
     ];
  1. 读取数据库时需要的时间可能较长提供参数选择

      php artisan api:make -MC 

    ps:可以作为一个项目多个版本的管理,或者单独布置多个项目接口管理

本作品采用《CC 协议》,转载必须注明作者和本文链接
本帖由系统于 9个月前 自动加精
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
讨论数量: 6

支持一下,有空的时候 试用一下,感谢

10个月前 评论
Fringe

有空试一下,神烦 apidoc 每次巴拉巴拉写一堆 :joy:

9个月前 评论

同样是 apidoc 写文档试一下

9个月前 评论

安装是成功的,但是找不到 api:make 命令,无法生成文档,laravel 版本 8.12

7个月前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!