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