init admin

2025-11-07 09:56:20 +08:00
commit d9d7ddc05d
2718 changed files with 665424 additions and 0 deletions
@@ -0,0 +1,102 @@
+<?php
+return [
+    'enable'  => true,
+    'apidoc' => [
+        // （选配）文档标题，显示在左上角与首页
+        'title'              => 'Apidoc',
+        // （选配）文档描述，显示在首页
+        'desc'               => '',
+        // （必须）设置文档的应用/版本
+        'apps'           => [
+            [
+                // （必须）标题
+                'title'=>'Api接口',
+                // （必须）控制器目录地址
+                'path'=>'app\api\controller',
+                // （必须）唯一的key
+                'key'=>'api',
+            ]
+        ],
+        // （必须）指定通用注释定义的文件地址
+        'definitions'        => "app\common\controller\Definitions",
+        // （必须）自动生成url规则，当接口不添加@Apidoc\Url ("xxx")注解时，使用以下规则自动生成
+        'auto_url' => [
+            // 字母规则，lcfirst=首字母小写；ucfirst=首字母大写；
+            'letter_rule' => "lcfirst",
+            // url前缀
+            'prefix'=>"",
+            // 处理url中每个key
+            'handle_key'=>function($key){
+               return str_ireplace('Controller', "", $key);
+            }
+        ],
+        // （选配）是否自动注册路由
+        'auto_register_routes'=>false,
+        // （必须）缓存配置
+        'cache'              => [
+            // 是否开启缓存
+            'enable' => false,
+        ],
+        // （必须）权限认证配置
+        'auth'               => [
+            // 是否启用密码验证
+            'enable'     => false,
+            // 全局访问密码
+            'password'   => "123456",
+            // 密码加密盐
+            'secret_key' => "apidoc#hg_code",
+            // 授权访问后的有效期
+            'expire' => 24*60*60
+        ],
+        // 全局参数
+        'params'=>[
+            // （选配）全局的请求Header
+            'header'=>[
+                // name=字段名，type=字段类型，require=是否必须，default=默认值，desc=字段描述
+                ['name'=>'token','type'=>'string','require'=>true,'desc'=>'身份令牌Token'],
+                ['name'=>'client','type'=>'string','require'=>true,'desc'=>'客户端标识',"default"=>"web"],
+            ],
+            // （选配）全局的请求Query
+            'query'=>[
+                // 同上 header
+            ],
+            // （选配）全局的请求Body
+            'body'=>[
+                // 同上 header
+            ],
+        ],
+        // 全局响应体
+        'responses'=>[
+            // 成功响应体
+            'success'=>[
+                ['name'=>'code','desc'=>'状态','type'=>'int','require'=>1,"default"=>0],
+                ['name'=>'msg','desc'=>'提示信息','type'=>'string','require'=>1],
+                //参数同上 headers；main=true来指定接口Returned参数挂载节点
+                ['name'=>'data','desc'=>'数据','main'=>true,'type'=>'object','require'=>1],
+            ],
+            // 异常响应体
+            'error'=>[
+                ['name'=>'code','desc'=>'状态','type'=>'int','require'=>1,'md'=>'/docs/HttpError.md'],
+                ['name'=>'msg','desc'=>'提示信息','type'=>'string','require'=>1],
+            ]
+        ],
+        //（选配）默认作者
+        'default_author'=>'',
+        //（选配）默认请求类型
+        'default_method'=>'GET',
+        //（选配）Apidoc允许跨域访问
+        'allowCrossDomain'=>false,
+        /**
+         * （选配）解析时忽略带@注解的关键词，当注解中存在带@字符并且非Apidoc注解，如 @key test，此时Apidoc页面报类似以下错误时:
+         * [Semantical Error] The annotation "@key" in method xxx() was never imported. Did you maybe forget to add a "use" statement for this annotation?
+         */
+        'ignored_annitation'=>[],
+
+        // （选配）数据库配置
+        'database'=>[],
+        // （选配）Markdown文档
+        'docs'              => [],
+        // （选配）接口生成器配置 注意：是一个二维数组
+        'generator' =>[]
+    ]
+];