Laravel使用命令根据注释一键生成接口名称文档

1、接口注释模板

/**
     * @api {POST} /admin/addAdmin 添加管理员
     * @apiVersion 1.0.0
     * @apiGrouP 管理员
     * @apiParam {String} phone 必填-手机号
     * @apiParam {String} nickname 必填-昵称
     * @apiParam {String} password 必填-密码
     * @apiParam {File} image 选填-头像
     * @apiSuccessExample {json} Success-Response:
     * HTTP/1.1 200 OK
     *
     * @apiSampleRequest off
     * @apiDescription
     * 【author】:浪里小白龙
     * 【createTime】:9:59 2023-07-10
     */
    public function addAdmin(AdminRule $request, AdminService $service)
    {
        $data['phone'] = $request->input('phone');
        $data['nickname'] = $request->input('nickname');
        $data['password'] = $request->input('password');
        $data['image'] = $request->file('image')??'';

        return $this->back($service->addAdmin($data));
    }

2、在namespace App\Console\Commands下创建OperationType类:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Str;
use ReflectionClass;
use Route;
use DB;
use App\Model\OperationType;
use App\Http\Middleware\VerifyPermissions;
use Artisan;

class OperationTypeSeeder extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'operationType:sync';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = '根据注释内容同步操作类型';

    /**
     * 不经过权限验证的路由
     *
     * @var array
     */
    public $exception = [
        'sanctum/csrf-cookie',
    ];

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $sortData = [];

        // 清理表
        DB::statement('SET FOREIGN_KEY_CHECKS=0;');
        OperationType::query()->truncate();
        DB::statement('SET FOREIGN_KEY_CHECKS=1;');

        foreach (Route::getRoutes()->getRoutes() as $route)
        {
            $action = $route->getAction();

            // 过滤排除路径in_array('get', $route->methods) ||
            if (in_array($route->uri(), $this->exception)) {
                continue;
            }

            // 验证控制器并执行同步
            if (array_key_exists('controller', $action))
            {
                // 获取注释
                $reflector = new ReflectionClass($route->getController());
                $comment = $reflector->getMethod($route->getActionMethod())->getDocComment();

                // 组合kv
                if (preg_match_all('/@(\w+)\s+(.*)\r?\n/m', $comment, $matches)){
                    $result = array_combine($matches[1], $matches[2]);
                }

                // 整理导入数据
                if ($result && isset($result['api'])) {
                    $row = explode(" ",$result['api']);
                    if (empty($row[2])) $row[2]='';
                    $name =  trim($row[2]);
                    $path = trim($row[1]);
                    $path = substr_replace($path, '',0,1);
                    $method = strtolower($route->methods[0]);
                    $module_str = substr($path, 0, 2);
                    if ($module_str == 'wx') {
                        $module = 2;//小程序
                    } else {
                        $module = 1;
                    }
                    $this->createOperationType($name, $path, $method, $module);
                }
            }
        }
    }

    /**
     * 创建权限
     *
     * @param [type] $name 方法名称
     * @param [type] $path 控制器名称和方法名称
     * @param [type] $method 请求方式
     * @param $module int 所属模块:1后台 2小程序
     * @return \App\Model\OperationType
     */
    private function createOperationType($name, $path, $method, $module)
    {
        return OperationType::create([
            'name' => $name,
            'path' => $path,
            'method' => $method,
            'module' => $module,
        ]);
    }
}

3、创建对应的model:App\Model\OperationType

<?php

namespace App\Model;

use Illuminate\Database\Eloquent\Model;

class OperationType extends Model
{
    //日志类型
    protected $table = 'zs_operation_type';//绑定表
    protected $primaryKey = 't_id';//绑定主键id
    public $timestamps = false;
    protected $fillable = [ //需指定字段,否则无法批量写入
        'name',
        'path',
        'method',
        'module'
    ];
}

Model文件:

class OperationType extends Model
{
    // 操作类型
    protected $table = 'hzy_operation_log';//绑定表
    protected $primaryKey = 'id';//绑定主键id
    public $timestamps = true;
    protected $fillable = [
        'name',
        'path',
        'method',
        'module',
    ];
}

4、指令命令将:数据自动写入数据库

php artisan operation:sync

//该命令获取到的参数
Array
(
    [api] => {POST} /admin/addAdmin 添加管理员
    [apiVersion] => 1.0.0
    [apiGrouP] => 管理员
    [apiParam] => {File} image 选填-头像
    [apiSuccessExample] => {json} Success-Response:
    [apiSampleRequest] => off
    [apiDescription] => * 【author】:浪里小白龙
)

数据库生成的结果:


image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容

  • Laravel框架一:原理机制篇 Laravel作为在国内国外都颇为流行的PHP框架,风格优雅,其拥有自己的一些特...
    Mr_Z_Heng阅读 3,689评论 0 13
  • Artisan 是 Laravel 的命令行接口的名称,它提供了许多实用的命令来帮助你开发 Laravel 应用,...
    李景磊阅读 517评论 0 0
  • Controller 控制器// 创建一个控制器php artisan make:controller XXXCo...
    VitaAin阅读 1,323评论 0 3
  • Laravel 学习交流 QQ 群:375462817 本文档前言Laravel 文档写的很好,只是新手看起来会有...
    Leonzai阅读 7,912评论 2 12
  • 默认将 Eloquent 的模型直接放置到 app 目录下,开发者可以自行选择放置的位置。对于国内开发者,尤其是 ...
    wz998阅读 1,244评论 0 0