配置参数

2022年8月26日 06:05 配置 大约 8 分钟

# 配置参数

提示

安装插件后会在/config/目录生成一个apidoc.php的配置文件,以下为该文件可配置的参数说明

默认配置文件请查看 apidoc.php (opens new window)

# title

  • 类型: string
  • 默认值: APi接口文档

页面的标题,显示在左上角与首页

# desc

  • 类型: string

文档说明,文档首页处显示

# default_method

  • 类型: string
  • 默认值: GET

默认的请求类型,编写接口注解时,不配置Method参数时,为该配置的默认类型

# default_author

  • 类型: string
  • 默认值: GET

默认的作者名称,编写接口注解时,不配置Author时,为该配置的默认作者

# notDebug

  • 类型: boolean
  • 默认值: false

设置为true时关闭接口调试功能

# apps

  • 类型: array
  • 默认值: undefined
  • 支持版本:>=2.1.0

多应用/多版本管理配置

// config/apidoc.php

'apps' => [
    [
        'title'=>'后台管理',
        'path'=>'app\admin\controller',
        'folder'=>'admin',
        'groups'  => [
            ['title'=>'基础模块','name'=>'base'],
            ['title'=>'示例模块','name'=>'demo'],
            ['title'=>'多级模块','name'=>'subMenu',
                'children'=>[
                    ['title'=>'多级v1','name'=>'subv1',],
                    ['title'=>'多级v2','name'=>'subv2'],
                ]
            ],
        ],
        // 'controllers'=>[
        //     'app\admin\controller\BaseDemo',
        //     'app\admin\controller\CrudDemo',
        // ],
        // 'headers'=>[
        //     ['name'=>'token','type'=>'string','desc'=>'admin应用的全局请求头参数token'],
        // ],
        // 'parameters'=>[
        //     ['name'=>'abc','type'=>'string','desc'=>'admin应用的全局请求体参数abc'],
        // ],
    ],
    [
        'title'=>'演示示例',
        'path'=>'app\demo\controller',
        'folder'=>'demo',
        'items'=>[
            ['title'=>'V1.0','path'=>'app\demo\controller\v1','folder'=>'v1'],
            ['title'=>'V2.0','path'=>'app\demo\controller\v2','folder'=>'v2']
        ],
        
    ],
],
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

apps配置数组的参数说明

参数名 类型 说明
title string 应用的名称
path string 应用的目录
folder string 应用的文件夹名称
password string 应用的访问密码,不配置则无需密码
host string 应用接口调试时,使用该host发起请求,通常用于多应用多域名时配置
items array 多层应用配置
groups array 应用的控制器分组
controllers array<\string> 指定api文档解析的控制器
headers array 指定当前应用的全局请求头参数,参数定义参考全局参数headers
parameters array 指定当前应用的全局请求体参数,参数定义参考全局参数parameters
notDebug boolean 指定当前应用关闭接口调试功能

apps中groups控制器分组参数说明

参数名 类型 说明
title string 分组标题
name string 分组名称,对应控制器注解@Apidoc\Group("name")
children array 多层分组

# definitions

  • 类型: string
  • 默认值: app\common\controller\Definitions

指定公共注释定义的控制器地址

# ignored_annitation

  • 类型: array

指定忽略带@的注解报错,如:'ignored_annitation'=>['abc','name']

# cache

  • 类型: array

缓存配置,开启后需手动更新接口参数,关闭则每次刷新重新生成接口数据

# cache.enable

  • 类型: boolean
  • 默认值:false

是否开启缓存

# auth

  • 类型: array

进入接口问页面的权限认证配置

# auth.enable

  • 类型: boolean
  • 默认值:false

是否启用权限认证,启用则需登录

# auth.password

  • 类型: string
  • 默认值:123456

进入接口文档页面的登录密码

# auth.secret_key

  • 类型: string
  • 默认值:apidoc#hg_code

密码加密的盐,请务必更改

# auth.expire

  • 类型: number
  • 默认值:24*\60*\60

密码访问有效期,超过本时间需重新输入访问密码

# headers

  • 类型: array
  • 默认值: undefined
  • 支持版本:>=2.4.0

全局请求头参数,配置后,所有接口请求头参数都统一加上这些参数,如接口单独定义了将会覆盖配置中的全局参数

// config/apidoc.php

// 全局的请求头参数
'headers'=>[
    ['name'=>'token','type'=>'string','require'=>true,'desc'=>'登录票据'],
    ['name'=>'shopid','type'=>'int','desc'=>'店铺id'],
],
1
2
3
4
5
6
7

# parameters

  • 类型: array
  • 默认值: undefined
  • 支持版本:>=2.4.0

全局请求参数,配置后,所有接口请求参数都统一加上这些参数,如接口单独定义了将会覆盖配置中的全局参数

// config/apidoc.php

// 全局的请求参数
'parameters'=>[
    ['name'=>'code','type'=>'string','desc'=>'全局code'],
],
1
2
3
4
5
6

# responses

  • 类型: string/object/array
  • 默认值: 如下示例

统一的请求响应体,当配置为字符串时,只在接口详情页面响应结果Responses右侧的问号处做展示用

// config/apidoc.php

'responses'=>[
    ['name'=>'code','desc'=>'状态码','type'=>'int'],
    ['name'=>'message','desc'=>'操作描述','type'=>'string'],
    ['name'=>'data','desc'=>'业务数据','main'=>true,'type'=>'object'],
],

1
2
3
4
5
6
7
8

# auto_url

  • 类型: array

当api接口不无注解@Apidoc\Url(xxx)时,api文档url的自动生成规则

# auto_url.letter_rule

  • 类型: lcfirst | ucfirst
  • 默认值:undefined

url每个参数的首字母大小写规则,lcfirst首字母小写,ucfirst首字母大写

# auto_url.multistage_route_separator

  • 类型: atring
  • 默认值:.

多级路由分隔符

# auto_url.custom

  • 类型: function
  • 默认值:undefined

自定义生成规则,如下:

'auto_url' => [
    'custom' =>function($class,$method){
        return "/".str_replace('\\','/',$class).$method;
    },
],
1
2
3
4
5

# allowCrossDomain

  • 类型: boolean
  • 默认值: false

适用于TP6,是否允许跨域访问apidoc的相关接口,TP5自行修改手动添加的路由即可

# docs

  • 类型: array
  • 默认值: undefined

Markdown文档配置

// config/apidoc.php
<?php
return [
    // markdown 文档
    'docs' => [
        ['title'=>'md语法示例','path'=>'docs/Use'],
        [
            'title'=>'HTTP响应编码',
            'children'=>[
                ['title'=>'status错误码说明','path'=>'docs/${app[0].folder}/HttpStatus'],
                ['title'=>'code错误码说明','path'=>'docs/${app[0].folder}/HttpCode_${app[1].folder}'],
            ],
        ]
    ]
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# path可用变量说明

  • ${lang}当前语言变量。

  • 变量写法${app[N].folder}其中的N表示apps中配置的层级:

比如配置为如下

'apps' => [
    ['title'=>'后台管理','path'=>'app\admin\controller','folder'=>'admin'],
    [
        'title'=>'演示示例',
        'path'=>'app\demo\controller',
        'folder'=>'demo',
        'items'=>[
            ['title'=>'V1.0','path'=>'app\demo\controller\v1','folder'=>'v1'],
            ['title'=>'V2.0','path'=>'app\demo\controller\v2','folder'=>'v2']
        ]
    ],
],
'docs'=>[
    ['title'=>'Http状态码','path'=>'docs/${app[0].folder}/HttpCode_${app[1].folder}'],
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1、当应用/版本选为后台管理的应用时,此时${app[0].folder}就等于admin 由于该应用配置无子级items此时的${app[1].folder}也就为空。最终文件地址为dosc/admin/HttpCode_.md

2、当应用/版本选为演示示例-V1.0时,此时${app[0].folder}就等于demo 由于该应用配置存在子级(多个版本)items此时的${app[1].folder}也就为v1。最终文件地址为dosc/admin/HttpCode_v1.txt

# generator

  • 类型: array
  • 默认值: undefined

代码生成器配置,具体看注释

配置中的 path、namespace、template可使用应用变量,${app[N].folder}其中的N表示apps中配置的层级:

// config/apidoc.php
<?php
return [
    // 代码生成器配置 注意:是一个二维数组
    'generator' =>[
        [
            // 标题
            'title'=>'创建Crud',
            // 是否启用
            'enable'=>true,
            // 执行中间件,具体请查看下方中间件介绍
            'middleware'=>[
                \app\middleware\CreateCrudMiddleware::class
            ],
            // 生成器窗口的表单配置
            'form' =>[
                // 表单显示列数
                'colspan'=>3,
                // 表单项字段配置
                'items'=>[
                    [
                        // 表单项标题
                        'title'=>'控制器标题',
                        // 字段名
                        'field'=>'controller_title',
                        // 输入类型,支持:input、select
                        'type'=>'input',
                        // 输入项属性
                        'props'=>[
                            // 提示文本
                            'placeholder'=>'请输入',
                            // type类型为select时有效,multiple=多选
                            'mode' =>'multiple',
                            // type类型为select时有效,最多显示选项的个数
                            'maxTagCount'=>1,
                            // type类型为select时有效,下拉选项数据
                            'options'=>[
                                // 每个选项的标题与值,label=标题,value=值
                                ['label'=>'选项A','value'=>1],
                            ]
                        ],
                        // 验证规则
                        'rules'=>[
                            // 必填的验证
                            ['required'=>true,'message'=>'请输入控制器文件名'],
                            // 自定义正则验证
                            ['pattern'=>'^[A-Z]{1}([a-zA-Z0-9]|[._]){2,19}$','message'=>'请输入正确的目录名'],
                        ]
                    ],
                ]
            ],
            // 文件生成配置,注意:是一个二维数组
            'files'=>[
                [
                    // 生成文件的文件夹地址,或php文件地址
                    'path'=>'app\${app[0].folder}\controller',
                    // 生成文件的命名空间
                    'namespace'=>'app\${app[0].folder}\controller',
                    // 模板文件地址
                    'template'=>'template/controller.tpl',
                    // 名称
                    'name'=>'controller',
                    // 验证规则
                    'rules'=>[
                        ['required'=>true,'message'=>'请输入控制器文件名'],
                        ['pattern'=>'^[A-Z]{1}([a-zA-Z0-9]|[._]){2,19}$','message'=>'请输入正确的目录名'],
                    ]
                ],
                [
                    'name'=>'service',
                    'path'=>'app\${app[0].folder}\services',
                    'template'=>'template/service.tpl',
                ],
                [
                    'name'=>'validate',
                    'path'=>'app\${app[0].folder}\validate',
                    'template'=>'template/validate.tpl',
                ],
                [
                    // 这里的path地址为php文件地址,当指定到php文件地址时,不会创建文件,而会将模板内容添加的该.php文件内
                    'path'=>'app\${app[0].folder}\route\admin.php',
                    'name'=>'route',
                    'template'=>'template/route.tpl',
                ],
            ],
            // 数据表配置
            'table'=>[
                // 可选的字段类型
                'field_types'=>[
                    "int",
                    "tinyint",
                    "integer",
                    "float",
                    "decimal",
                    "char",
                    "varchar",
                    "blob",
                    "text",
                    "point",
                ],
                // 数据表配置,注意:是一个二维数组,可定义多个数据表
                'items'=>[
                     [
                         // 表标题
                        'title'=>'主表',
                        // 数据库引擎
                        'database_engine'=>"",
                        // 模型名验证规则
                        'model_rules'=>[
                            ['pattern'=>'^[A-Z]{1}([a-zA-Z0-9]|[._]){2,19}$','message'=>'模型文件名错误,请输入大写字母开头的字母+数字,长度2-19的组合']
                        ],
                        // 表名验证规则
                        'table_rules'=>[
                            ['pattern'=>'^[a-z]{1}([a-z0-9]|[_]){2,19}$','message'=>'表名错误,请输入小写字母开头的字母+数字+下划线,长度2-19的组合']
                        ],
                        // 显示的提示文本
                        'desc'=>'提示说明文本',
                        // 生成模型的命名空间
                        'namespace'=>'app\model',
                        // 生成模型的文件夹地址
                        'path'=>"app\model",
                        // 模板文件地址
                        'template'=>"template/model.tpl",
                        // 自定义配置列
                        'columns'=>[
                            [
                                // 标题
                                'title'=>'验证',
                                // 字段名
                                'field'=>'check',
                                // 字段类型,input、select、checkbox、number
                                'type'=>'select',
                                //列宽 px
                                'width'=>180,
                                // 输入项属性
                                'props'=>[
                                    // 提示文本
                                    'placeholder'=>'请输入1',
                                    // type类型为select时有效,multiple=多选
                                    'mode' =>'multiple',
                                    // type类型为select时有效,最多显示选项的个数
                                    'maxTagCount'=>1,
                                     // type类型为select时有效,下拉选项数据
                                    'options'=>[
                                        // 每个选项的标题与值,label=标题,value=值
                                        ['label'=>'必填','value'=>'require','message'=>'缺少必要参数{$item.field}'],
                                    ]
                                ],
                            ],
                            //...
                        ],
                        // 默认字段
                        'default_fields'=>[
                            [
                                // 字段名
                                'field'=> 'id',
                                // 字段注释
                                'desc'=> '唯一id',
                                // 字段类型
                                'type'=> 'int',
                                // 字段长度
                                'length'=> 11,
                                // 默认值
                                'default'=> '',
                                // 非Null
                                'not_null'=> true,
                                // 主键
                                'main_key'=> true,
                                // 自增
                                'incremental'=> true,
                                //也可以添加自定义列的值
                                'query'=>true, 

                            ],
                            //...
                        ],
                        // 添加一行字段时,默认的值
                        'default_values'=>[
                            //这里就是对应每列字段名=>值
                            'type'=>'varchar',
                            'length'=>255,
                            //...
                        ],
                    ],
                ]
            ]
        ],
    ]
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189