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