摘要:將會(huì)是一個(gè)基于的自動(dòng)生成文檔的庫(kù)雖然現(xiàn)在是版本但是本庫(kù)旨在為開發(fā)者提供思路。具體優(yōu)化也可以大家自己開發(fā)一套屬于自己的庫(kù)。蘋果綠葡萄紫其中為模板類型,暫時(shí)提供兩種模板風(fēng)格,分別為蘋果綠和葡萄紫,雖然兩套模板都是巨丑無(wú)比。
reflection_api_doc
將會(huì)是一個(gè)基于 thinkphp5 的PHP自動(dòng)生成api文檔的庫(kù)
雖然現(xiàn)在是 v1.0_beta 版本 但是本庫(kù)旨在為開發(fā)者提供思路。具體優(yōu)化也可以大家自己開發(fā)一套屬于自己的庫(kù)。
Github 地址
composer( packagist.org )
使用方法:
在 extra 目錄下創(chuàng)建文件名為 documents.php 的配置文件。
配置文件內(nèi)容如下:
"北京想得美科技有限公司", "description" => ""想的美app" | APi接口文檔等等。", "template" => "apple", // 蘋果綠:apple 葡萄紫:grape "class" => [ "appindexcontrollerDemo", "appindexcontrollerProduct", "appindexcontrollerStore", ], ];
其中 template 為模板類型,暫時(shí)提供兩種模板風(fēng)格,分別為蘋果綠和葡萄紫,雖然兩套模板都是巨丑無(wú)比。所以使用的過程中也可以自己開發(fā)模板。
重點(diǎn): class 為將要生成文檔的類(帶命名空間)
示例:
注釋參數(shù) | 含義 | 說明 |
---|---|---|
@title | 標(biāo)題 | 文檔生成的類方法標(biāo)題 |
@desc | 描述 | 格式如下,地址、請(qǐng)求方式、備注等 |
@param | 接收參數(shù) | 格式如下,名稱、類型、是否必須、默認(rèn)值、說明等 |
@return | 返回參數(shù) | 格式如下,名稱、類型、是否必須、說明等 |
類的具體實(shí)現(xiàn)方法:
/** * @title 文章接口管理 */ class Article extends Controller { /** * @title 獲取文章列表 * @desc {"0":"接口地址:http://open.opqnext.com/index.php?c=article&a=index","1":"請(qǐng)求方式:GET","2":"接口備注:必須傳入keys值用于通過加密驗(yàn)證"} * @param {"name":"page","type":"int","required":true,"default":"1","desc":"頁(yè)數(shù)"} * @param {"name":"keys","type":"string","required":true,"default":"xxx","desc":"加密字符串,substr(md5("約定秘鑰".$page),8,16)"} * @param {"name":"word","type":"string","required":false,"default":"null","desc":"搜索關(guān)鍵字"} * @param {"name":"cate","type":"int","required":false,"default":0,"desc":"分類ID,不傳表示所有分類"} * @param {"name":"size","type":"int","required":false,"default":5,"desc":"每頁(yè)顯示條數(shù),默認(rèn)為5"} * @return {"name":"status","type":"int","required":true,"desc":"返回碼:1成功,0失敗","level":1} * @return {"name":"message","type":"string","required":true,"desc":"返回信息","level":1} * @return {"name":"data","type":"array","required":true,"desc":"返回?cái)?shù)據(jù)","level":1} * @return {"name":"id","type":"string","required":true,"desc":"文章ID(22位字符串)","level":2} * @return {"name":"title","type":"string","required":true,"desc":"文章標(biāo)題","level":2} * @return {"name":"thumb","type":"string","required":true,"desc":"文章列表圖","level":2} * @return {"name":"content","type":"text","required":true,"desc":"文章內(nèi)容","level":2} * @return {"name":"cate","type":"int","required":true,"desc":"文章分類","level":2} * @return {"name":"tags","type":"array","required":true,"desc":"文章標(biāo)簽","level":2} * @return {"name":"id","type":"string","required":true,"desc":"標(biāo)簽ID","level":3} * @return {"name":"tag","type":"string","required":true,"desc":"標(biāo)簽名稱","level":3} * @return {"name":"count","type":"int","required":true,"desc":"標(biāo)簽使用數(shù)","level":3} * @return {"name":"img","type":"array","required":true,"desc":"文章組圖","level":2} */ public function index(){ //... 具體實(shí)現(xiàn)方法 }
預(yù)覽
長(zhǎng)相一般的蘋果綠:
長(zhǎng)相也一般的葡萄紫:
支持
如果有使用自動(dòng)生成文檔的需求或者之類的,歡迎加入 QQ群:452209691 共同探討。
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://m.hztianpu.com/yun/25791.html
摘要:數(shù)據(jù)庫(kù)文件已經(jīng)上傳,安裝配置就可以使用簡(jiǎn)稱即基于的后臺(tái)管理系統(tǒng)官方文檔地址在線體驗(yàn)地址賬戶密碼線上倉(cāng)庫(kù)在線地址源代碼下載克隆直接下載本地部署運(yùn)行環(huán)境要求建議配置虛擬域名若不清楚,請(qǐng)自行解決之,方便接下來(lái)開展你的開發(fā)工作。 喜歡就Star,不只是Fork; 想要分享的動(dòng)機(jī)才是驅(qū)動(dòng)力,而技術(shù)僅僅是一種方法。 數(shù)據(jù)庫(kù)文件已經(jīng)上傳,安裝配置就可以使用 showImg(https://seg...
摘要:數(shù)據(jù)庫(kù)文件已經(jīng)上傳,安裝配置就可以使用簡(jiǎn)稱即基于的后臺(tái)管理系統(tǒng)官方文檔地址在線體驗(yàn)地址賬戶密碼線上倉(cāng)庫(kù)在線地址源代碼下載克隆直接下載本地部署運(yùn)行環(huán)境要求建議配置虛擬域名若不清楚,請(qǐng)自行解決之,方便接下來(lái)開展你的開發(fā)工作。 喜歡就Star,不只是Fork; 想要分享的動(dòng)機(jī)才是驅(qū)動(dòng)力,而技術(shù)僅僅是一種方法。 數(shù)據(jù)庫(kù)文件已經(jīng)上傳,安裝配置就可以使用 showImg(https://seg...
摘要:即基于拿來(lái)即用高性能后臺(tái)管理系統(tǒng)官方文檔地址在線體驗(yàn)地址賬戶密碼線上倉(cāng)庫(kù)在線地址源代碼下載克隆直接下載本地部署運(yùn)行環(huán)境要求建議配置虛擬域名若不清楚,請(qǐng)自行解決之,方便接下來(lái)開展你的開發(fā)工作。 新版本在線體驗(yàn)地址已經(jīng)上線,歡迎體驗(yàn)? ---2017-01-14 喜歡就Star,不只是Fork; 想要分享的動(dòng)機(jī)才是驅(qū)動(dòng)力,而技術(shù)僅僅是一種方法。 ====================...
摘要:即基于拿來(lái)即用高性能后臺(tái)管理系統(tǒng)官方文檔地址在線體驗(yàn)地址賬戶密碼線上倉(cāng)庫(kù)在線地址源代碼下載克隆直接下載本地部署運(yùn)行環(huán)境要求建議配置虛擬域名若不清楚,請(qǐng)自行解決之,方便接下來(lái)開展你的開發(fā)工作。 新版本在線體驗(yàn)地址已經(jīng)上線,歡迎體驗(yàn)? ---2017-01-14 喜歡就Star,不只是Fork; 想要分享的動(dòng)機(jī)才是驅(qū)動(dòng)力,而技術(shù)僅僅是一種方法。 ====================...
閱讀 764·2021-11-23 09:51
閱讀 3355·2019-08-30 15:54
閱讀 490·2019-08-30 15:52
閱讀 3165·2019-08-30 13:58
閱讀 2991·2019-08-30 13:53
閱讀 2742·2019-08-29 14:18
閱讀 2485·2019-08-27 10:54
閱讀 2417·2019-08-26 18:09