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