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