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