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