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