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