开云网页版

教育行业OA系统开发框（kuàng）架说（shuō）明文档（dàng）

2021年 11月 15日发布

# 框架说明

## 介绍

该项目是一款基于ThinkPHP5.1 + LayuiAdmin 的极速后台开发框架。

必读文档参（cān）考链接（jiē）:

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

## 部署说明

环境要求

```
PHP >= 7.0
Mysql >= 5.6 (需支持innodb引（yǐn）擎（qíng）)
Nginx >= 1.15
PDO PHP Extension
MBstring PHP Extension
CURL PHP Extension
Composer (用于（yú）管（guǎn）理第（dì）三方扩（kuò）展（zhǎn）包)
Node.js (可选, 上（shàng）线部署时打（dǎ）包前（qián）端框架)
```

安装方法（fǎ）

# 1、安装依（yī）赖

SVN同（tóng）步下代码后,  通过 composer 安装依赖包（bāo）

```
composer install
```

# 2、命令行（háng）安装

一键安装FastAdmin的参数请使用`php think install --help`查看

```
php think install -u 数（shù）据库用户名 -p 数据库密（mì）码
```

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

添加（jiā）虚（xū）拟主（zhǔ）机并（bìng）绑定（dìng）到（dào）应用目录下的public目（mù）录（lù），请尽（jìn）量使用独立（lì）域名

# 4、设置调试模式

本地调试（shì）是（shì），在项（xiàng）目根目（mù）录下添（tiān）加.ENV文（wén）件，配置文件（jiàn）会（huì）覆盖项目配置，内容参考如下：

```
//基础配置（zhì）
APP_NAME = 教育行（háng）业办公系（xì）统
APP_DEBUG =  true
APP_TRACE =  true

//数据（jù）库配置（zhì）
DATABASE_HOSTNAME = localhost
DATABASE_DATABASE = eduoa
DATABASE_USERNAME = root
DATABASE_PASSWORD = 123456
DATABASE_HOSTPORT = 3306
DATABASE_PREFIX = eduoa_
```

注意：.ENV文件为个（gè）人本（běn）地开发私有文件，请勿加（jiā）入加入项（xiàng）目Git或SVN中

## 其它（tā）命令（lìng）

一键生（shēng）成（chéng）API文档

请确保（bǎo）你的（de）API模块下的控制（zhì）器代码没有语法错误，控（kòng）制（zhì）器类注释、方法名注释（shì）完（wán）整（zhěng），注释规则（zé）请参（cān）考（kǎo）下方注释（shì）规则；

# 常用（yòng）命令：

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

# 参数介绍

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

# 注释规则

在我们的控制器中通（tōng）常分为两部分注释，一是（shì）控制器头部的注释（shì），二（èr）是控（kòng）制器（qì）方法（fǎ）的（de）注释

控制器注释

| 名称         | 描（miáo）述                                   | 示（shì）例        |
| ------------ | -------------------------------------- | ----------- |
| @ApiSector   | API分组（zǔ）名称                            | (测试分（fèn）组（zǔ）)  |
| @ApiRoute    | API接口URL，此@ApiRoute只是基础URL     | (/api/test) |
| @ApiInternal | 忽略的控制（zhì）器,表示此（cǐ）控制将不加入API文档 | 无          |

控（kòng）制器方法（fǎ）注释

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

# 常见问题

如果控制器的（de）方法是`private`或`protected`的，则将不会生成相应的API文档

如果注（zhù）释不生效，请检查注释文（wén）本是否正（zhèng）确（què）.

本文（wén）档由开云网页版和百牛网络构建

回顶部

开云网页版

开云网页版