国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

一個基于 thinkphp5 的自動生成 api 文檔的包

cgspine / 487人閱讀

摘要:將會是一個基于的自動生成文檔的庫雖然現(xiàn)在是版本但是本庫旨在為開發(fā)者提供思路。具體優(yōu)化也可以大家自己開發(fā)一套屬于自己的庫。蘋果綠葡萄紫其中為模板類型,暫時提供兩種模板風格,分別為蘋果綠和葡萄紫,雖然兩套模板都是巨丑無比。

reflection_api_doc

將會是一個基于 thinkphp5 的PHP自動生成api文檔的庫

雖然現(xiàn)在是 v1.0_beta 版本 但是本庫旨在為開發(fā)者提供思路。具體優(yōu)化也可以大家自己開發(fā)一套屬于自己的庫。

Github 地址

composer( packagist.org )

使用方法:

在 extra 目錄下創(chuàng)建文件名為 documents.php 的配置文件。

配置文件內(nèi)容如下:

 "北京想得美科技有限公司",
    "description" => ""想的美app" | APi接口文檔等等。",
    "template" => "apple", // 蘋果綠:apple 葡萄紫:grape
    "class" => [
        "appindexcontrollerDemo",
        "appindexcontrollerProduct",
        "appindexcontrollerStore",
    ],
];

其中 template 為模板類型,暫時提供兩種模板風格,分別為蘋果綠和葡萄紫,雖然兩套模板都是巨丑無比。所以使用的過程中也可以自己開發(fā)模板。

重點: class 為將要生成文檔的類(帶命名空間)

示例:

注釋參數(shù) 含義 說明
@title 標題 文檔生成的類方法標題
@desc 描述 格式如下,地址、請求方式、備注等
@param 接收參數(shù) 格式如下,名稱、類型、是否必須、默認值、說明等
@return 返回參數(shù) 格式如下,名稱、類型、是否必須、說明等

類的具體實現(xiàn)方法:

/**
 * @title 文章接口管理
 */
class Article extends Controller
{
    /**
     * @title 獲取文章列表
     * @desc  {"0":"接口地址:http://open.opqnext.com/index.php?c=article&a=index","1":"請求方式:GET","2":"接口備注:必須傳入keys值用于通過加密驗證"}
     * @param {"name":"page","type":"int","required":true,"default":"1","desc":"頁數(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":"每頁顯示條數(shù),默認為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":"返回數(shù)據(jù)","level":1}
     * @return {"name":"id","type":"string","required":true,"desc":"文章ID(22位字符串)","level":2}
     * @return {"name":"title","type":"string","required":true,"desc":"文章標題","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":"文章標簽","level":2}
     * @return {"name":"id","type":"string","required":true,"desc":"標簽ID","level":3}
     * @return {"name":"tag","type":"string","required":true,"desc":"標簽名稱","level":3}
     * @return {"name":"count","type":"int","required":true,"desc":"標簽使用數(shù)","level":3}
     * @return {"name":"img","type":"array","required":true,"desc":"文章組圖","level":2}
     */
    public function index(){
        //... 具體實現(xiàn)方法
    }

預(yù)覽

長相一般的蘋果綠:

長相也一般的葡萄紫:

支持

如果有使用自動生成文檔的需求或者之類的,歡迎加入 QQ群:452209691 共同探討。

文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/25791.html

相關(guān)文章

  • 基于ThinkPHP5拿來即用高性能后臺管理系統(tǒng)

    摘要:數(shù)據(jù)庫文件已經(jīng)上傳,安裝配置就可以使用簡稱即基于的后臺管理系統(tǒng)官方文檔地址在線體驗地址賬戶密碼線上倉庫在線地址源代碼下載克隆直接下載本地部署運行環(huán)境要求建議配置虛擬域名若不清楚,請自行解決之,方便接下來開展你的開發(fā)工作。 喜歡就Star,不只是Fork; 想要分享的動機才是驅(qū)動力,而技術(shù)僅僅是一種方法。 數(shù)據(jù)庫文件已經(jīng)上傳,安裝配置就可以使用 showImg(https://seg...

    894974231 評論0 收藏0
  • 基于ThinkPHP5拿來即用高性能后臺管理系統(tǒng)

    摘要:數(shù)據(jù)庫文件已經(jīng)上傳,安裝配置就可以使用簡稱即基于的后臺管理系統(tǒng)官方文檔地址在線體驗地址賬戶密碼線上倉庫在線地址源代碼下載克隆直接下載本地部署運行環(huán)境要求建議配置虛擬域名若不清楚,請自行解決之,方便接下來開展你的開發(fā)工作。 喜歡就Star,不只是Fork; 想要分享的動機才是驅(qū)動力,而技術(shù)僅僅是一種方法。 數(shù)據(jù)庫文件已經(jīng)上傳,安裝配置就可以使用 showImg(https://seg...

    SHERlocked93 評論0 收藏0
  • TP-admin即基于ThinkPHP5拿來即用高性能后臺管理系統(tǒng)

    摘要:即基于拿來即用高性能后臺管理系統(tǒng)官方文檔地址在線體驗地址賬戶密碼線上倉庫在線地址源代碼下載克隆直接下載本地部署運行環(huán)境要求建議配置虛擬域名若不清楚,請自行解決之,方便接下來開展你的開發(fā)工作。 新版本在線體驗地址已經(jīng)上線,歡迎體驗? ---2017-01-14 喜歡就Star,不只是Fork; 想要分享的動機才是驅(qū)動力,而技術(shù)僅僅是一種方法。 ====================...

    Hydrogen 評論0 收藏0
  • TP-admin即基于ThinkPHP5拿來即用高性能后臺管理系統(tǒng)

    摘要:即基于拿來即用高性能后臺管理系統(tǒng)官方文檔地址在線體驗地址賬戶密碼線上倉庫在線地址源代碼下載克隆直接下載本地部署運行環(huán)境要求建議配置虛擬域名若不清楚,請自行解決之,方便接下來開展你的開發(fā)工作。 新版本在線體驗地址已經(jīng)上線,歡迎體驗? ---2017-01-14 喜歡就Star,不只是Fork; 想要分享的動機才是驅(qū)動力,而技術(shù)僅僅是一種方法。 ====================...

    Aklman 評論0 收藏0

發(fā)表評論

0條評論

最新活動
閱讀需要支付1元查看
<