初始化本地仓库
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
'enable' => true,
|
||||
'debug' => true,
|
||||
'controller_suffix' => 'Controller',
|
||||
'controller_reuse' => false,
|
||||
'version' => '1.0.0',
|
||||
'title' => 'Swagger示例插件',
|
||||
'description' => 'Swagger示例插件',
|
||||
'author' => 'Madong',
|
||||
'type' => 'madong',
|
||||
];
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 插件信息配置
|
||||
*/
|
||||
|
||||
return [
|
||||
'name' => 'example',
|
||||
'identifier' => 'example',
|
||||
'version' => '1.0.0',
|
||||
'description' => 'Swagger示例插件',
|
||||
'author' => 'Madong',
|
||||
'author_email' => 'support@madong.tech',
|
||||
'website' => 'https://www.madong.tech',
|
||||
'require' => [
|
||||
'composer' => [
|
||||
'ramsey/uuid' => '^4.7',
|
||||
],
|
||||
],
|
||||
'npm_require' => [
|
||||
'admin' => [
|
||||
'lodash' => '^4.17.21',
|
||||
],
|
||||
'web' => [
|
||||
'axios' => '^1.6.0',
|
||||
],
|
||||
],
|
||||
'uninstall' => [
|
||||
'undeletable' => true,
|
||||
'drop_tables' => false,
|
||||
'remove_dependencies' => false,
|
||||
],
|
||||
'type' => 'madong',
|
||||
];
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
/**
|
||||
* 示例插件 - 审核配置示例
|
||||
*
|
||||
* 此文件展示如何为插件配置审核功能
|
||||
* 系统会自动扫描并合并此配置
|
||||
*/
|
||||
|
||||
return [
|
||||
// 插件信息
|
||||
'plugin' => [
|
||||
'name' => 'example',
|
||||
'display_name' => '示例插件',
|
||||
'version' => '1.0.0',
|
||||
],
|
||||
|
||||
// ==================== 审核类型配置示例 ====================
|
||||
|
||||
// 示例1:简单配置(仅使用默认映射)
|
||||
'example_simple' => [
|
||||
'morph_alias' => 'example_simple', // 对应 morph_map.php 中的别名
|
||||
'display_name' => '简单示例审核',
|
||||
'priority' => 5,
|
||||
|
||||
// 字段映射(如果为空,使用系统默认映射)
|
||||
'fields' => [
|
||||
'title' => [
|
||||
'type' => 'attribute',
|
||||
'source' => 'title', // 模型中的字段名
|
||||
'label' => '标题',
|
||||
'fallback' => '默认标题',
|
||||
],
|
||||
'content' => [
|
||||
'type' => 'attribute',
|
||||
'source' => 'description', // 可能字段名不同
|
||||
'label' => '内容',
|
||||
'fallback' => '无内容',
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
// 示例2:复杂配置(使用关联和回调)
|
||||
'example_complex' => [
|
||||
'morph_alias' => 'example_complex',
|
||||
'display_name' => '复杂示例审核',
|
||||
'priority' => 10,
|
||||
|
||||
'fields' => [
|
||||
'title' => [
|
||||
'type' => 'callback',
|
||||
'callback' => function($model) {
|
||||
// 自定义标题生成逻辑
|
||||
return $model->name . ' (ID: ' . $model->id . ')';
|
||||
},
|
||||
'label' => '标题',
|
||||
'fallback' => '未命名',
|
||||
],
|
||||
'content' => [
|
||||
'type' => 'attribute',
|
||||
'source' => 'description',
|
||||
'label' => '描述',
|
||||
'format' => 'html_to_text', // 应用格式化函数
|
||||
'fallback' => '无描述',
|
||||
],
|
||||
'applicant' => [
|
||||
'type' => 'relation',
|
||||
'source' => 'creator', // 关联关系名
|
||||
'attribute' => 'username', // 关联模型的字段
|
||||
'label' => '创建人',
|
||||
'fallback' => '未知用户',
|
||||
],
|
||||
'category' => [
|
||||
'type' => 'relation',
|
||||
'source' => 'category', // 关联关系
|
||||
'attribute' => 'name', // 关联模型的字段
|
||||
'label' => '分类',
|
||||
'fallback' => '未分类',
|
||||
],
|
||||
'tags' => [
|
||||
'type' => 'relation',
|
||||
'source' => 'tags', // 多对多关联
|
||||
'attribute' => 'name', // 关联模型的字段
|
||||
'label' => '标签',
|
||||
'multiple' => true, // 多值字段
|
||||
'format' => 'implode:、', // 多个值用顿号连接
|
||||
'fallback' => '无标签',
|
||||
],
|
||||
],
|
||||
|
||||
// 审核回调(可选)
|
||||
'callbacks' => [
|
||||
'approved' => 'plugin\example\app\service\ExampleReviewService@onApproved',
|
||||
'rejected' => 'plugin\example\app\service\ExampleReviewService@onRejected',
|
||||
],
|
||||
|
||||
// 额外信息(用于前端显示)
|
||||
'extra' => [
|
||||
'icon' => 'ant-design:experiment-outlined',
|
||||
'color' => '#722ed1',
|
||||
'route' => '/example/detail/{id}', // 详情页路由
|
||||
],
|
||||
],
|
||||
|
||||
// ==================== 字段格式化函数示例 ====================
|
||||
|
||||
'formatters' => [
|
||||
'my_custom_formatter' => function($value) {
|
||||
// 自定义格式化函数
|
||||
return strtoupper($value);
|
||||
},
|
||||
'currency' => function($amount, $currency = '¥') {
|
||||
// 货币格式化
|
||||
return $currency . number_format($amount, 2);
|
||||
},
|
||||
'short_date' => function($timestamp) {
|
||||
// 短日期格式
|
||||
return date('Y-m-d', $timestamp);
|
||||
},
|
||||
],
|
||||
|
||||
// ==================== 插件级默认字段 ====================
|
||||
|
||||
'default_fields' => [
|
||||
'created_time' => [
|
||||
'type' => 'attribute',
|
||||
'source' => 'created_at',
|
||||
'label' => '创建时间',
|
||||
'format' => 'datetime:Y年m月d日 H:i:s',
|
||||
],
|
||||
'status_text' => [
|
||||
'type' => 'callback',
|
||||
'callback' => function($model) {
|
||||
$statusMap = [0 => '待处理', 1 => '进行中', 2 => '已完成'];
|
||||
return $statusMap[$model->status] ?? '未知';
|
||||
},
|
||||
'label' => '状态',
|
||||
],
|
||||
],
|
||||
|
||||
// ==================== 使用说明 ====================
|
||||
|
||||
'_notes' => [
|
||||
'1. 确保在 morph_map.php 中配置了模型别名映射',
|
||||
'2. priority 数字越大,排序越靠前',
|
||||
'3. 字段映射优先级:插件特定配置 > 插件默认配置 > 系统默认配置',
|
||||
'4. 可以自定义格式化函数,然后在 format 中使用',
|
||||
],
|
||||
];
|
||||
@@ -0,0 +1,77 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of webman.
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the MIT-LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @author walkor<walkor@workerman.net>
|
||||
* @copyright walkor<walkor@workerman.net>
|
||||
* @link http://www.workerman.net/
|
||||
* @license http://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
|
||||
use Webman\Route;
|
||||
use WebmanTech\Swagger\Swagger;
|
||||
use OpenApi\Annotations as OA;
|
||||
|
||||
|
||||
/**
|
||||
* 注册example APP路由
|
||||
*/
|
||||
Route::group('/example', function () {
|
||||
|
||||
// Swagger 文档路由配置
|
||||
Swagger::create()->registerRoute([
|
||||
'route_prefix' => '/openapi',
|
||||
'register_route' => true,
|
||||
'openapi_doc' => [
|
||||
'scan_path' => [
|
||||
base_path('plugin/example'),
|
||||
],
|
||||
'exclude' => [
|
||||
// 排除非控制器文件和目录
|
||||
],
|
||||
'processors' => [
|
||||
// 添加自定义处理器来过滤基类
|
||||
],
|
||||
'modify' => function (OA\OpenApi $openapi) {
|
||||
$openapi->info->title = config('app.name') . ' API';
|
||||
$openapi->info->version = '1.0.0';
|
||||
$openapi->servers = [
|
||||
new OA\Server(
|
||||
[
|
||||
'url' => '/example',
|
||||
'description' => request()->host(),
|
||||
]
|
||||
),
|
||||
];
|
||||
/** @phpstan-ignore-next-line */
|
||||
if (!$openapi->components instanceof OA\Components) {
|
||||
$openapi->components = new OA\Components([]);
|
||||
}
|
||||
$openapi->components->securitySchemes = [
|
||||
new OA\SecurityScheme([
|
||||
'securityScheme' => 'api_key',
|
||||
'type' => 'apiKey',
|
||||
'name' => config('core.jwt.app.token_name', 'Authorization'),
|
||||
'in' => 'header',
|
||||
]),
|
||||
];
|
||||
|
||||
// 过滤掉不应该出现在文档中的路径
|
||||
// foreach ($openapi->paths as $path => $pathItem) {
|
||||
// // 过滤掉测试路径
|
||||
// if (str_contains($path, '/test/')) {
|
||||
// unset($openapi->paths[$path]);
|
||||
// }
|
||||
// }
|
||||
},
|
||||
|
||||
],
|
||||
]);
|
||||
|
||||
// 注意:ResponseTestController 的路由已通过 Swagger 注解自动生成
|
||||
// 无需在此手动定义路由
|
||||
// Swagger 会根据 @OA\Get 注解自动注册路由到 /adminapi/test/response/*
|
||||
});
|
||||
Reference in New Issue
Block a user