thinkers/fastadmin_apidoc

基于Fastadmin Apidoc 基础修改的文档生成命令

维护者

详细信息

github.com/hellolxc/fastadmin_apidoc

源代码

问题

安装次数: 4

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:think-extend

1.0.1 2021-07-15 01:38 UTC

Requires

  • php: >=5.6
  • composer-plugin-api: ^1.0||^2.0

Requires (Dev)

Apache-2.0 3a1cdbf8a9483ae251a6348a4bfd9e0ba531cd2a

  • thinker <lxc_yx.woop@139.com>

This package is auto-updated.

Last update: 2024-09-15 13:00:59 UTC

README

安装

composer require thinkers/fastadmin_apidoc

介绍

在保留全部原生命令的基础上，基于fastadmin api文档生成代码进行了修改，新增以下功能：

  • 指定任意目录生成文档
  • 排除指定的类不生成文档

命令行

php think apidoc

配置

配置文件位于 extra/apidoc.php

[
    "includeDir" => [//需要生成文档的目录 填写项目根目录的相对路径
        '/addons/test/controller/',
        '/application/admin/controller/',
    ],
    
    "excludeClass" => [//支持排除指定的类
        'addons\test\controller\Index',
        addons\test\controller\Index::class,
    ]

如何支持fastadmin后台插件一键生成文档

修改/application/admin/controller/Command.php 文件，找到doexecute()方法，添加以下代码：

$commandName = "\\app\\admin\\command\\" . ucfirst($commandtype);
//在上面👆这一行后添加下面👇的代码 即可将命令替换为apidoc 一键生成文档就支持自定义目录 和 排除指定类啦 
if ($commandtype === "api") {
    $commandName = "\\thinkers\\apidoc\\commands\\". ucfirst($commandtype);
}