kaiyun开云官方网页版-kaiyun开云(中国)

教育（yù）行（háng）业OA系统开发框架说（shuō）明文档

2021年 11月 15日发布（bù）

# 框架说（shuō）明

## 介绍

该项（xiàng）目是一款基（jī）于ThinkPHP5.1 + LayuiAdmin 的极速后台开发框架。

必读（dú）文档参考链接:

1. PHP 标准规范: <PSR 是 PHP Standard Recommendations 的简写，由 PHP FIG 组织制定的 PHP 规（guī）范，是（shì） PHP 开（kāi）发的实践（jiàn）标（biāo）准> (*请严格（gé）安装标准编（biān）码，代码提交时会进行编码（mǎ）规范规则自动校验，不通过无法（fǎ）提交*)；
2. ThinkPHP5.1文档：请仔熟（shú）读该文档，明白框架原理；真正（zhèng）的（de）把框架用好，提（tí）高代码（mǎ）性能和编码效率；
3. ThinkPHP官方博（bó）客：改文档（dàng）介绍了一些关于TP框架（jià）的一些（xiē）技巧和说明，有助于理解框架的应用；
4. LayUI前端框架：LayUI框架文档（dàng）介绍，特别是关于模块（kuài）规范、命名规（guī）则、表格、表单和（hé）模板引擎（qíng）一定（dìng）要研（yán）究透彻；
5. LayuiAdmin文档（dàng）：layuiAdmin pro （单页版）是完全基（jī）于 layui 架构而（ér）成（chéng）的后台管理模（mó）板系统，可（kě）以更（gèng）轻松地实现前（qián）后（hòu）端（duān）分离（lí）；

## 部署说明

环境（jìng）要求

```
PHP >= 7.0
Mysql >= 5.6 (需支持innodb引擎)
Nginx >= 1.15
PDO PHP Extension
MBstring PHP Extension
CURL PHP Extension
Composer (用于管理第三方扩展（zhǎn）包（bāo）)
Node.js (可选, 上线部署时（shí）打包前端框架)
```

安装方法

# 1、安装依赖

SVN同步下代码后（hòu）,  通过 composer 安装依赖包

```
composer install
```

# 2、命令（lìng）行安装

一键安装FastAdmin的（de）参（cān）数请使用`php think install --help`查看

```
php think install -u 数据（jù）库用户名 -p 数据库（kù）密码
```

# 3、绑定虚拟主机目（mù）录

添（tiān）加虚（xū）拟主机（jī）并绑定到应用目录下的（de）public目（mù）录，请（qǐng）尽（jìn）量使用独（dú）立域名

# 4、设（shè）置调试（shì）模式

本（běn）地调试是，在项（xiàng）目根目录下添加.ENV文件，配置文件会覆盖项目配置，内容参考如下：

```
//基础配（pèi）置
APP_NAME = 教育行业办（bàn）公（gōng）系统
APP_DEBUG =  true
APP_TRACE =  true

//数据库配置
DATABASE_HOSTNAME = localhost
DATABASE_DATABASE = eduoa
DATABASE_USERNAME = root
DATABASE_PASSWORD = 123456
DATABASE_HOSTPORT = 3306
DATABASE_PREFIX = eduoa_
```

注意：.ENV文件为个人本地（dì）开（kāi）发私有（yǒu）文件，请勿（wù）加入加入项目Git或SVN中

## 其（qí）它命令（lìng）

一（yī）键生成API文档

请确保你的API模块（kuài）下的控制器代码（mǎ）没有语法错（cuò）误，控（kòng）制器（qì）类注释、方法名注释完整，注释规则请（qǐng）参考下（xià）方（fāng）注（zhù）释规则；

# 常用命令：

```
//一（yī）键生成API文档
php think api --force=true
//指定https://www.example.com为API接口请求域名,默认为空
php think api -u https://www.example.com --force=true
//输出自定义文件为myapi.html,默（mò）认为api.html
php think api -o myapi.html --force=true
//修改API模板为mytemplate.html，默（mò）认为index.html
php think api -e mytemplate.html --force=true
//修改（gǎi）标题为FastAdmin,作者为作者
php think api -t FastAdmin -a Karson --force=true
//查看API接口命令行帮助
php think api -h
```

# 参数介绍

```
-u, --url[=URL]            默认API请求URL地（dì）址 [default: ""]
-m, --module[=MODULE]      模块（kuài）名(admin/index/api) [default: "api"]
-o, --output[=OUTPUT]      输出文件 [default: "api.html"]
-e, --template[=TEMPLATE]  模板（bǎn）文件 [default: "index.html"]
-f, --force[=FORCE]        覆盖模式（shì） [default: false]
-t, --title[=TITLE]        文档标题 [default: ""]
-a, --author[=AUTHOR]      文档作者（zhě） [default: ""]
-c, --class[=CLASS]        扩展类 (multiple values allowed)
-l, --language[=LANGUAGE]  语言 [default: "zh-cn"]
```

# 注（zhù）释规则

在我们的控制器中通常（cháng）分为两部分注释（shì），一（yī）是控制器头部（bù）的注释，二是（shì）控制器方法的注（zhù）释

控制器（qì）注释

| 名（míng）称         | 描述                                   | 示例        |
| ------------ | -------------------------------------- | ----------- |
| @ApiSector   | API分组名称（chēng）                            | (测试分（fèn）组)  |
| @ApiRoute    | API接口URL，此@ApiRoute只是基础URL     | (/api/test) |
| @ApiInternal | 忽略的控制器,表示此控制（zhì）将不加（jiā）入（rù）API文档 | 无          |

控制器（qì）方法注释（shì）

| 名称              | 描述（shù）                                                       | 示例                                                         |
| ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------ |
| @ApiTitle         | API接口的标题,为空时将自动（dòng）匹（pǐ）配注释的文本信息               | (测（cè）试标题)                                                   |
| @ApiSummary       | API接（jiē）口描述                                                | (测（cè）试（shì）描述)                                                   |
| @ApiRoute         | API接口（kǒu）地址（zhǐ）,为空时（shí）将自动计算请求地址                       | (/api/test/index)                                            |
| @ApiMethod        | API接口请求方（fāng）法,默认为GET                                  | (POST)                                                       |
| @ApiSector        | API分（fèn）组,默认（rèn）按（àn）钮控制器或控制（zhì）器的@ApiSector进行（háng）分组（zǔ）         | (测试（shì）分组)                                                   |
| @ApiParams        | API请求（qiú）参数,如果在@ApiRoute中有对（duì）应的（de）{@参数名（míng）}，将进行替换 | (name="id", type="integer", required=true, description="会（huì）员ID") |
| @ApiHeaders       | API请求（qiú）传递的Headers信息                                   | (name=token, type=string, required=true, description="请求的（de）Token") |
| @ApiReturn        | API返回的结果示例（lì）                                          | ({"code":1,"msg":"返回成功"})                                |
| @ApiReturnParams  | API返回的（de）结果（guǒ）参数介绍                                      | (name="list", type="array", description="数据列表", sample="") |
| @ApiReturnHeaders | API返（fǎn）回（huí）的Headers信（xìn）息                                       | (name="token", type="integer", rdescription=“介（jiè）绍”, sample="123456") |
| @ApiInternal      | 忽略的（de）方法,表示此方（fāng）法将不加入文档                          | 无                                                           |

# 常（cháng）见（jiàn）问题

如果控制器的方法是（shì）`private`或`protected`的，则将不会（huì）生成（chéng）相（xiàng）应（yīng）的API文档（dàng）

如（rú）果注释不生效，请检查注释文本（běn）是否（fǒu）正确.

本文档由 kaiyun开云官方网页版和百牛网（wǎng）络构建（jiàn）

回顶部

kaiyun开云官方网页版-kaiyun开云(中国)

kaiyun开云官方网页版-kaiyun开云(中国)