教育行业（yè）OA系统开发（fā）框架说明（míng）文档

2021年 11月 15日发布

# 框架说明## 介绍该项目是一款基于ThinkPHP5.1 + LayuiAdmin 的极速后台（tái）开发框架。必读文（wén）档（dàng）参考链（liàn）接:1. PHP 标准规范: <PSR 是 PHP Standard Recommendations 的简写，由 PHP FIG 组织（zhī）制定的 PHP 规范，是 PHP 开（kāi）发的（de）实践（jiàn）标准> (*请（qǐng）严格安装（zhuāng）标准编码，代码提交时会进行编（biān）码规（guī）范规则自动（dòng）校验，不（bú）通过无法提交*)；
2. ThinkPHP5.1文档：请仔熟读该文档，明白框架原理；真正的把框架用（yòng）好，提高代码性能（néng）和编（biān）码效率；
3. ThinkPHP官（guān）方博客：改文档介绍了一些关于TP框架的一（yī）些技巧（qiǎo）和说明，有助于理解框架（jià）的应用；
4. LayUI前端框架（jià）：LayUI框架文（wén）档介绍（shào），特别是关于模块规范（fàn）、命名规则、表格、表单和模板引擎一定要研究（jiū）透彻；
5. LayuiAdmin文档（dàng）：layuiAdmin pro （单页版）是完全基于 layui 架构（gòu）而成的后（hòu）台（tái）管理模板系统，可以（yǐ）更轻松地实现前后端分离；## 部署说明### 环境（jìng）要（yào）求```
PHP >= 7.0
Mysql >= 5.6 (需支持（chí）innodb引擎)
Nginx >= 1.15
PDO PHP Extension
MBstring PHP Extension
CURL PHP Extension
Composer (用于管（guǎn）理第三方扩（kuò）展包（bāo）)
Node.js (可选, 上（shàng）线部署时打包前端框架)
```### 安装方法#### 1、安装（zhuāng）依赖SVN同步下代码后,  通过 composer 安装（zhuāng）依赖包```
composer install
```#### 2、命令（lìng）行（háng）安装一键安装（zhuāng）FastAdmin的参数请使用`php think install --help`查看（kàn）```
php think install -u 数据（jù）库用户名（míng） -p 数据库（kù）密（mì）码
```#### 3、绑定虚拟（nǐ）主机目（mù）录添加虚拟（nǐ）主机（jī）并绑（bǎng）定（dìng）到应用目录下的public目录，请尽量使用独立域名#### 4、设置调（diào）试模（mó）式本地调试是，在项（xiàng）目根目录下添加.ENV文件（jiàn），配（pèi）置文（wén）件会覆盖项目（mù）配（pèi）置（zhì），内容（róng）参（cān）考如下（xià）：```
//基础配置
APP_NAME = 教育行业办（bàn）公系（xì）统
APP_DEBUG =  true
APP_TRACE =  true//数（shù）据（jù）库配置
DATABASE_HOSTNAME = localhost
DATABASE_DATABASE = eduoa
DATABASE_USERNAME = root
DATABASE_PASSWORD = 123456
DATABASE_HOSTPORT = 3306
DATABASE_PREFIX = eduoa_
```注意：.ENV文件为个人本地开发私有文件（jiàn），请勿加入加入（rù）项目Git或SVN中## 其它命（mìng）令（lìng）### 一（yī）键生成API文档（dàng）请确（què）保你的API模（mó）块下的控制器代码没有语法（fǎ）错误，控（kòng）制器类（lèi）注释（shì）、方（fāng）法（fǎ）名注（zhù）释完（wán）整，注释规则请（qǐng）参考下方注释规（guī）则；#### 常用命令：```
//一（yī）键生（shēng）成（chéng）API文档（dàng）
php think api --force=true
//指定（dìng）https://www.example.com为API接口请求域名,默（mò）认（rèn）为空
php think api -u https://www.example.com --force=true
//输（shū）出自定义文（wén）件为（wéi）myapi.html,默认为api.html
php think api -o myapi.html --force=true
//修（xiū）改API模（mó）板为mytemplate.html，默认为index.html
php think api -e mytemplate.html --force=true
//修（xiū）改标题为FastAdmin,作者为（wéi）作者
php think api -t FastAdmin -a Karson --force=true
//查看API接（jiē）口命令行帮助（zhù）
php think api -h
```#### 参数（shù）介绍```
-u, --url[=URL]            默认API请求URL地址 [default: ""]
-m, --module[=MODULE]      模（mó）块名(admin/index/api) [default: "api"]
-o, --output[=OUTPUT]      输出（chū）文件 [default: "api.html"]
-e, --template[=TEMPLATE]  模板文件 [default: "index.html"]
-f, --force[=FORCE]        覆（fù）盖模式 [default: false]
-t, --title[=TITLE]        文档标题 [default: ""]
-a, --author[=AUTHOR]      文档作（zuò）者 [default: ""]
-c, --class[=CLASS]        扩展类 (multiple values allowed)
-l, --language[=LANGUAGE]  语言 [default: "zh-cn"]
```#### 注（zhù）释规则在我们（men）的控制（zhì）器中通常分为两部分（fèn）注释，一是控制器头部的注释，二（èr）是控制器方法的注释控制（zhì）器注释（shì）| 名称         | 描（miáo）述（shù）                                   | 示（shì）例        |
| ------------ | -------------------------------------- | ----------- |
| @ApiSector   | API分（fèn）组名称                            | (测试分组（zǔ）)  |
| @ApiRoute    | API接口URL，此@ApiRoute只是（shì）基础URL     | (/api/test) |
| @ApiInternal | 忽略的控制器（qì）,表示此控制将不加入API文档（dàng） | 无          |控制器方法注释| 名称              | 描述                                                       | 示（shì）例                                                         |
| ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------ |
| @ApiTitle         | API接口的标题,为空时将自动匹配注释（shì）的（de）文本信息               | (测试（shì）标题)                                                   |
| @ApiSummary       | API接口描述                                                | (测试描述（shù）)                                                   |
| @ApiRoute         | API接口地址（zhǐ）,为空（kōng）时将自动计（jì）算请求地址                       | (/api/test/index)                                            |
| @ApiMethod        | API接口请求方法,默（mò）认为（wéi）GET                                  | (POST)                                                       |
| @ApiSector        | API分组（zǔ）,默认按钮控制器或控制器的@ApiSector进行分（fèn）组         | (测试分（fèn）组（zǔ）)                                                   |
| @ApiParams        | API请求参（cān）数,如果在@ApiRoute中有对（duì）应的{@参数名（míng）}，将（jiāng）进行替换 | (name="id", type="integer", required=true, description="会员（yuán）ID") |
| @ApiHeaders       | API请求传递的Headers信息                                   | (name=token, type=string, required=true, description="请求的Token") |
| @ApiReturn        | API返回的结果示例                                          | ({"code":1,"msg":"返回（huí）成功"})                                |
| @ApiReturnParams  | API返回（huí）的结果参数介（jiè）绍                                      | (name="list", type="array", description="数据列表", sample="") |
| @ApiReturnHeaders | API返（fǎn）回的Headers信息（xī）                                       | (name="token", type="integer", rdescription=“介绍（shào）”, sample="123456") |
| @ApiInternal      | 忽（hū）略的方法,表示此（cǐ）方法将不加入文档                          | 无                                                           |#### 常见问题如（rú）果控制器的方法是`private`或`protected`的，则将不会生成相应的API文档如果注释不生效，请检查注释文（wén）本是否正确.

本文档（dàng）由（yóu） pp电子和百牛网络构建

回顶部

pp电子(中国游)官方在线平台

教育行业（yè）OA系统开发（fā）框架说明（míng）文档

2021年 11月 15日发布

pp电子(中国游)官方在线平台

pp电子(中国游)官方在线平台

教育行业（yè）OA系统开发（fā）框架说明（míng）文档

2021年 11月 15日 发布

pp电子(中国游)官方在线平台

2021年 11月 15日发布