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