基于tp5的在線文檔

瀏覽:4039 最后更新:2018-06-03 23:24 分類:類庫 關鍵字: api在線文檔
1.安裝
// 使用composer安裝
composer require hao/api-doc
####2、配置參數 安裝好擴展后在 application\extra\ 文件夾下會生成 doc.php 配置文件 在controller參數中添加對應的類

'controller' => [
'app\\api\\controller\\Demo'
]
####3、在相關接口類中增加注釋參數( group 參數將接口分組,可選) 方法如下:返回參數支持數組及多維數組(參考test文件夾中的Index.php文件)

接口備注示例
返回數據格式,僅支持json數據格式

<?php
namespace app\reflection\controller;


/**
* @title 文檔index類
*/
class Index{
public function __construct(){

}

/**
* @title save方法
* @description
* @author 作者
* @url //www.baidu.com/save.html
* @method POST
*
* @code 200 成功
* @code 201 失敗
*
* @param string name 名稱 '' false
* @param int age 年齡 '' false
* @return {"code":200,"message":"666","data":{"param":1}}
*/
public function save(){

}

/**
* @title delete方法
* @description ajax請求時,header帶上Authorization信息;Authorization即為user_id token值(兩個參數之間,用英文空格)
* @author 作者
* @url //www.baidu.com/delete.html
* @method POST
*
* @code 200 成功
* @code 201 失敗
*
* @param string name2 名稱2 null false
* @param int age2 年齡2 null false
* @return {"code":400,"message":"111","data":[{"param":1}]}
*/
public function delete(){

}
}
####4、在瀏覽器訪問//你的域名/doc 查看接口文檔

評論( 相關
后面還有條評論,點擊查看>>