資料介紹
軟件簡介
基于 tp6 的 api 生成模塊,參考 fastadmin 的 api 模塊
引用
use jmwl\realapidoc\Builder; use think\facade\View;
使用
這里是所有的需要生成api的控制器路徑啦、所以,你可以先獲取到模塊下的所有控制器 Builder(["\app\admin\controller\Demo","\app\admin\controller\Index"])
$title="類名"; $url="http://real-think.jmwl51.com"; $lang=[ 'Info' => '基礎(chǔ)信息', 'Sandbox' => '在線測試', 'Sampleoutput' => '返回示例', 'Headers' => 'Headers', 'Parameters' => '參數(shù)', 'Body' => '正文', 'Name' => '名稱', 'Type' => '類型', 'Required' => '必選', 'Description' => '描述', 'Send' => '提交', 'Reset' => '重置', 'Tokentips' => 'Token在會員注冊或登錄后都會返回,WEB端同時存在于Cookie中', 'Apiurltips' => 'API接口URL', 'Savetips' => '點擊保存后Token和Api url都將保存在本地Localstorage中', 'Authorization' => '權(quán)限', 'NeedLogin' => '登錄', 'NeedRight' => '鑒權(quán)', 'ReturnHeaders' => '響應(yīng)頭', 'ReturnParameters' => '返回參數(shù)', 'Response' => '響應(yīng)輸出', ]; $config = [ 'sitename' => "測試", 'title' => $title, 'author' => "測試", 'description' => '', 'apiurl' => $url, 'language' => $lang, ]; //這里是所有的需要生成api的控制器路徑啦 $builder = new Builder(["\\app\\admin\\controller\\Demo","\\app\\admin\\controller\\Index"]); $content = $builder->render(root_path()."/extend/jmwl/realapidoc/template/index.html", ['config' => $config, 'lang' => $lang]); // dump($content); die; View::assign('config',$config); View::assign('docslist',$content["docsList"]); View::assign('lang',$content["lang"]); return View();
視圖
文件中的index.html就是視圖啦,放到正確的位置 我放在了 app\admin\view\api\index.html 對應(yīng)的控制器自然是 admin下的api控制器啦
控制器注釋
名稱 | 描述 | 示例 |
---|---|---|
@ApiSector | API分組名稱 | (測試分組) |
@ApiRoute | API接口URL,此@ApiRoute只是基礎(chǔ)URL | (/api/test) |
@ApiInternal | 忽略的控制器,表示此控制將不加入API文檔 | 無 |
@ApiWeigh | API方法的排序,值越大越靠前 | (99) |
控制器方法注釋
名稱 | 描述 | 示例 |
---|---|---|
@ApiTitle | API接口的標(biāo)題,為空時將自動匹配注釋的文本信息 | (測試標(biāo)題) |
@ApiSummary | API接口描述 | (測試描述) |
@ApiRoute | API接口地址,為空時將自動計算請求地址 | (/api/test/index) |
@ApiMethod | API接口請求方法,默認(rèn)為GET | (POST) |
@ApiSector | API分組,默認(rèn)按鈕控制器或控制器的@ApiSector進行分組 | (測試分組) |
@ApiParams | API請求參數(shù),如果在@ApiRoute中有對應(yīng)的{@參數(shù)名},將進行替換 | (, , required=true, ) |
@ApiHeaders | API請求傳遞的Headers信息 | (name=token, type=string, required=true, ) |
@ApiReturn | API返回的結(jié)果示例 | ({"code":1,"msg":"返回成功"}) |
@ApiReturnParams | API返回的結(jié)果參數(shù)介紹 | (, , required=true, ) |
@ApiReturnHeaders | API返回的Headers信息 | (, , required=true, ) |
@ApiInternal | 忽略的方法,表示此方法將不加入文檔 | 無 |
@ApiWeigh | API方法的排序,值越大越靠前 | (99) |
示范
namespace app\api\controller; /** * 測試API控制器 */ class Test extends \app\common\controller\Api { // 無需驗證登錄的方法 protected $noNeedLogin = ['test']; // 無需要判斷權(quán)限規(guī)則的方法 protected $noNeedRight = ['*']; /** * 首頁 * * 可以通過@ApiInternal忽略請求的方法 * @ApiInternal */ public function index() { return 'index'; } /** * 私有方法 * 私有的方法將不會出現(xiàn)在文檔列表 */ private function privatetest() { return 'private'; } /** * 測試方法 * * @ApiTitle (測試名稱) * @ApiSummary (測試描述信息) * @ApiSector (測試分組) * @ApiMethod (POST) * @ApiRoute (/api/test/test/id/{id}/name/{name}) * @ApiHeaders (name=token, type=string, required=true, ) * @ApiParams (, , required=true, ) * @ApiParams (, , required=true, ) * @ApiParams (, , , ) * @ApiReturnParams (, , required=true, ) * @ApiReturnParams (, , required=true, ) * @ApiReturnParams (, , , ) * @ApiReturn ({ 'code':'1', 'mesg':'返回成功' * }) */ public function test($id = '', $name = '') { $this->success("返回成功", $this->request->request()); } }
- 生成式AI對智能家居的影響 17次下載
- LabView工具包WebSocket-API主機下載 69次下載
- real-token基于tp6的權(quán)限驗證模塊
- 第6章:數(shù)字輸入/輸出模塊(I/O) 20次下載
- TP4100,TP4101,TP4102
- 愛華微膠囊記錄器TP-M725/TP-M525數(shù)據(jù)手冊 1次下載
- TP-LINK無線路由器升級軟件及說明 1次下載
- 16位CRC驗證碼生成VI工具下載 55次下載
- MPLAB REAL ICE在線仿真器功率監(jiān)視器開發(fā)工具的詳細(xì)中文資料概述
- MPLAB REAL ICE在線仿真器功率監(jiān)視器的介紹和使用指南詳細(xì)概述
- MPLAB REAL ICE 在線仿真器JTAG適配器的中文使用說明書
- Connecting_Real_People_with_Real_Solutions 5次下載
- iMX6_2D_API_Hardware_and_Platform_Independent_API_for_i.MX6_2D_Graphics 12次下載
- M25PE20-VMN6TP數(shù)據(jù)手冊 32次下載
- L2TP虛擬專用網(wǎng)
- 使用OpenVINO GenAI API的輕量級生成式AI 664次閱讀
- Kubernetes Gateway API攻略教程 923次閱讀
- N-API的JS堆對象生命周期管理 554次閱讀
- DDS信號生成模塊的Verilog實現(xiàn) 1939次閱讀
- 企業(yè)怎么選擇API網(wǎng)關(guān) 687次閱讀
- Katalon:API測試 1033次閱讀
- 關(guān)于API接口相關(guān)知識 API的權(quán)限與安全問題 1733次閱讀
- 什么是API,不同場景中的API 2235次閱讀
- 基于使用TP-4056模塊制造鋰離子電池充電器設(shè)計 6128次閱讀
- 如何解決TP-Link路由器無線信號的問題 5374次閱讀
- 什么是API網(wǎng)關(guān)為什么需要API網(wǎng)關(guān) 1.2w次閱讀
- tp4055中文資料匯總(tp4055引腳圖功能_內(nèi)部結(jié)構(gòu)及應(yīng)用電路) 2.8w次閱讀
- TP4056使用注意事項 5.1w次閱讀
- 如何使用API_api接口有什么優(yōu)點 2w次閱讀
- TP14管腳圖 3221次閱讀
下載排行
本周
- 1DD3118電路圖紙資料
- 0.08 MB | 1次下載 | 免費
- 2AD庫封裝庫安裝教程
- 0.49 MB | 1次下載 | 免費
- 3PC6206 300mA低功耗低壓差線性穩(wěn)壓器中文資料
- 1.12 MB | 1次下載 | 免費
- 4網(wǎng)絡(luò)安全從業(yè)者入門指南
- 2.91 MB | 1次下載 | 免費
- 5DS-CS3A P00-CN-V3
- 618.05 KB | 1次下載 | 免費
- 6海川SM5701規(guī)格書
- 1.48 MB | 次下載 | 免費
- 7H20PR5電磁爐IGBT功率管規(guī)格書
- 1.68 MB | 次下載 | 1 積分
- 8IP防護等級說明
- 0.08 MB | 次下載 | 免費
本月
- 1貼片三極管上的印字與真實名稱的對照表詳細(xì)說明
- 0.50 MB | 103次下載 | 1 積分
- 2涂鴉各WiFi模塊原理圖加PCB封裝
- 11.75 MB | 89次下載 | 1 積分
- 3錦銳科技CA51F2 SDK開發(fā)包
- 24.06 MB | 43次下載 | 1 積分
- 4錦銳CA51F005 SDK開發(fā)包
- 19.47 MB | 19次下載 | 1 積分
- 5PCB的EMC設(shè)計指南
- 2.47 MB | 16次下載 | 1 積分
- 6HC05藍(lán)牙原理圖加PCB
- 15.76 MB | 13次下載 | 1 積分
- 7802.11_Wireless_Networks
- 4.17 MB | 12次下載 | 免費
- 8蘋果iphone 11電路原理圖
- 4.98 MB | 6次下載 | 2 積分
總榜
- 1matlab軟件下載入口
- 未知 | 935127次下載 | 10 積分
- 2開源硬件-PMP21529.1-4 開關(guān)降壓/升壓雙向直流/直流轉(zhuǎn)換器 PCB layout 設(shè)計
- 1.48MB | 420064次下載 | 10 積分
- 3Altium DXP2002下載入口
- 未知 | 233089次下載 | 10 積分
- 4電路仿真軟件multisim 10.0免費下載
- 340992 | 191390次下載 | 10 積分
- 5十天學(xué)會AVR單片機與C語言視頻教程 下載
- 158M | 183342次下載 | 10 積分
- 6labview8.5下載
- 未知 | 81588次下載 | 10 積分
- 7Keil工具MDK-Arm免費下載
- 0.02 MB | 73815次下載 | 10 積分
- 8LabVIEW 8.6下載
- 未知 | 65989次下載 | 10 積分
評論