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