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