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