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