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