国产成人精品18p-国产精品网红主播美女-欧美亚洲日本日韩在线-麻豆爽爽妓女一区二区三区
<pre id="gcasu"></pre>
<s id="gcasu"><em id="gcasu"></em></s>
<td id="gcasu"><em id="gcasu"></em></td>
<td id="gcasu"></td>
<noframes id="gcasu"><pre id="gcasu"></pre></noframes>
教育行業(yè)OA系統(tǒng)開發(fā)框架說(shuō)明文檔
2021年 11月 15日 發(fā)布
# 框架說(shuō)明 ## 介紹 該項(xiàng)目是一款基于ThinkPHP5.1 + LayuiAdmin 的極速后臺(tái)開發(fā)框架。 必讀文檔參考鏈接: 1. PHP 標(biāo)準(zhǔn)規(guī)范: <PSR 是 PHP Standard Recommendations 的簡(jiǎn)寫，由 PHP FIG 組織制定的 PHP 規(guī)范，是 PHP 開發(fā)的實(shí)踐標(biāo)準(zhǔn)> (*請(qǐng)嚴(yán)格安裝標(biāo)準(zhǔn)編碼，代碼提交時(shí)會(huì)進(jìn)行編碼規(guī)范規(guī)則自動(dòng)校驗(yàn)，不通過無(wú)法提交*)； 2. ThinkPHP5.1文檔：請(qǐng)仔熟讀該文檔，明白框架原理；真正的把框架用好，提高代碼性能和編碼效率； 3. ThinkPHP官方博客：改文檔介紹了一些關(guān)于TP框架的一些技巧和說(shuō)明，有助于理解框架的應(yīng)用； 4. LayUI前端框架：LayUI框架文檔介紹，特別是關(guān)于模塊規(guī)范、命名規(guī)則、表格、表單和模板引擎一定要研究透徹； 5. LayuiAdmin文檔：layuiAdmin pro （單頁(yè)版）是完全基于 layui 架構(gòu)而成的后臺(tái)管理模板系統(tǒng)，可以更輕松地實(shí)現(xiàn)前后端分離； ## 部署說(shuō)明 ### 環(huán)境要求 ``` PHP >= 7.0 Mysql >= 5.6 (需支持innodb引擎) Nginx >= 1.15 PDO PHP Extension MBstring PHP Extension CURL PHP Extension Composer (用于管理第三方擴(kuò)展包) Node.js (可選, 上線部署時(shí)打包前端框架) ``` ### 安裝方法 #### 1、安裝依賴 SVN同步下代碼后, 通過 composer 安裝依賴包 ``` composer install ``` #### 2、命令行安裝 一鍵安裝FastAdmin的參數(shù)請(qǐng)使用`php think install --help`查看 ``` php think install -u 數(shù)據(jù)庫(kù)用戶名 -p 數(shù)據(jù)庫(kù)密碼 ``` #### 3、綁定虛擬主機(jī)目錄 添加虛擬主機(jī)并綁定到應(yīng)用目錄下的public目錄，請(qǐng)盡量使用獨(dú)立域名 #### 4、設(shè)置調(diào)試模式 本地調(diào)試是，在項(xiàng)目根目錄下添加.ENV文件，配置文件會(huì)覆蓋項(xiàng)目配置，內(nèi)容參考如下： ``` //基礎(chǔ)配置 APP_NAME = 教育行業(yè)辦公系統(tǒng) APP_DEBUG = true APP_TRACE = true //數(shù)據(jù)庫(kù)配置 DATABASE_HOSTNAME = localhost DATABASE_DATABASE = eduoa DATABASE_USERNAME = root DATABASE_PASSWORD = 123456 DATABASE_HOSTPORT = 3306 DATABASE_PREFIX = eduoa_ ``` 注意：.ENV文件為個(gè)人本地開發(fā)私有文件，請(qǐng)勿加入加入項(xiàng)目Git或SVN中 ## 其它命令 ### 一鍵生成API文檔 請(qǐng)確保你的API模塊下的控制器代碼沒有語(yǔ)法錯(cuò)誤，控制器類注釋、方法名注釋完整，注釋規(guī)則請(qǐng)參考下方注釋規(guī)則； #### 常用命令： ``` //一鍵生成API文檔 php think api --force=true //指定https://www.example.com為API接口請(qǐng)求域名,默認(rèn)為空 php think api -u https://www.example.com --force=true //輸出自定義文件為myapi.html,默認(rèn)為api.html php think api -o myapi.html --force=true //修改API模板為mytemplate.html，默認(rèn)為index.html php think api -e mytemplate.html --force=true //修改標(biāo)題為FastAdmin,作者為作者 php think api -t FastAdmin -a Karson --force=true //查看API接口命令行幫助 php think api -h ``` #### 參數(shù)介紹 ``` -u, --url[=URL] 默認(rèn)API請(qǐng)求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] 擴(kuò)展類 (multiple values allowed) -l, --language[=LANGUAGE] 語(yǔ)言 [default: "zh-cn"] ``` #### 注釋規(guī)則 在我們的控制器中通常分為兩部分注釋，一是控制器頭部的注釋，二是控制器方法的注釋 控制器注釋 | 名稱 | 描述 | 示例 | | ------------ | -------------------------------------- | ----------- | | @ApiSector | API分組名稱 | (測(cè)試分組) | | @ApiRoute | API接口URL，此@ApiRoute只是基礎(chǔ)URL | (/api/test) | | @ApiInternal | 忽略的控制器,表示此控制將不加入API文檔 | 無(wú) | 控制器方法注釋 | 名稱 | 描述 | 示例 | | ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | | @ApiTitle | API接口的標(biāo)題,為空時(shí)將自動(dòng)匹配注釋的文本信息 | (測(cè)試標(biāo)題) | | @ApiSummary | API接口描述 | (測(cè)試描述) | | @ApiRoute | API接口地址,為空時(shí)將自動(dòng)計(jì)算請(qǐng)求地址 | (/api/test/index) | | @ApiMethod | API接口請(qǐng)求方法,默認(rèn)為GET | (POST) | | @ApiSector | API分組,默認(rèn)按鈕控制器或控制器的@ApiSector進(jìn)行分組 | (測(cè)試分組) | | @ApiParams | API請(qǐng)求參數(shù),如果在@ApiRoute中有對(duì)應(yīng)的{@參數(shù)名}，將進(jìn)行替換 | (name="id", type="integer", required=true, description="會(huì)員ID") | | @ApiHeaders | API請(qǐng)求傳遞的Headers信息 | (name=token, type=string, required=true, description="請(qǐng)求的Token") | | @ApiReturn | API返回的結(jié)果示例 | ({"code":1,"msg":"返回成功"}) | | @ApiReturnParams | API返回的結(jié)果參數(shù)介紹 | (name="list", type="array", description="數(shù)據(jù)列表", sample="") | | @ApiReturnHeaders | API返回的Headers信息 | (name="token", type="integer", rdescription=“介紹”, sample="123456") | | @ApiInternal | 忽略的方法,表示此方法將不加入文檔 | 無(wú) | #### 常見問題 如果控制器的方法是`private`或`protected`的，則將不會(huì)生成相應(yīng)的API文檔 如果注釋不生效，請(qǐng)檢查注釋文本是否正確.
本文檔由
百牛網(wǎng)絡(luò)
構(gòu)建
#custom-toc-container
回頂部