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