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