99精品伊人亚洲|最近国产中文炮友|九草在线视频支援|AV网站大全最新|美女黄片免费观看|国产精品资源视频|精彩无码视频一区|91大神在线后入|伊人终合在线播放|久草综合久久中文

電子發(fā)燒友App

硬聲App

0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示
創(chuàng)作
電子發(fā)燒友網(wǎng)>電子資料下載>電子資料>real-apidoc基于tp6的api生成模塊

real-apidoc基于tp6的api生成模塊

2022-06-29 | zip | 0.02 MB | 次下載 | 免費

資料介紹

授權(quán)協(xié)議 BSD
開發(fā)語言 PHP
軟件類型 開源軟件

軟件簡介

基于 tp6 的 api 生成模塊,參考 fastadmin 的 api 模塊

引用

下載到 tp6 的extend\jmwl下

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());
    }

}
?

下載該資料的人也在下載 下載該資料的人還在閱讀
更多 >

評論

查看更多

下載排行

本周

  1. 1DD3118電路圖紙資料
  2. 0.08 MB   |  1次下載  |  免費
  3. 2AD庫封裝庫安裝教程
  4. 0.49 MB   |  1次下載  |  免費
  5. 3PC6206 300mA低功耗低壓差線性穩(wěn)壓器中文資料
  6. 1.12 MB   |  1次下載  |  免費
  7. 4網(wǎng)絡(luò)安全從業(yè)者入門指南
  8. 2.91 MB   |  1次下載  |  免費
  9. 5DS-CS3A P00-CN-V3
  10. 618.05 KB  |  1次下載  |  免費
  11. 6海川SM5701規(guī)格書
  12. 1.48 MB  |  次下載  |  免費
  13. 7H20PR5電磁爐IGBT功率管規(guī)格書
  14. 1.68 MB   |  次下載  |  1 積分
  15. 8IP防護等級說明
  16. 0.08 MB   |  次下載  |  免費

本月

  1. 1貼片三極管上的印字與真實名稱的對照表詳細(xì)說明
  2. 0.50 MB   |  103次下載  |  1 積分
  3. 2涂鴉各WiFi模塊原理圖加PCB封裝
  4. 11.75 MB   |  89次下載  |  1 積分
  5. 3錦銳科技CA51F2 SDK開發(fā)包
  6. 24.06 MB   |  43次下載  |  1 積分
  7. 4錦銳CA51F005 SDK開發(fā)包
  8. 19.47 MB   |  19次下載  |  1 積分
  9. 5PCB的EMC設(shè)計指南
  10. 2.47 MB   |  16次下載  |  1 積分
  11. 6HC05藍(lán)牙原理圖加PCB
  12. 15.76 MB   |  13次下載  |  1 積分
  13. 7802.11_Wireless_Networks
  14. 4.17 MB   |  12次下載  |  免費
  15. 8蘋果iphone 11電路原理圖
  16. 4.98 MB   |  6次下載  |  2 積分

總榜

  1. 1matlab軟件下載入口
  2. 未知  |  935127次下載  |  10 積分
  3. 2開源硬件-PMP21529.1-4 開關(guān)降壓/升壓雙向直流/直流轉(zhuǎn)換器 PCB layout 設(shè)計
  4. 1.48MB  |  420064次下載  |  10 積分
  5. 3Altium DXP2002下載入口
  6. 未知  |  233089次下載  |  10 積分
  7. 4電路仿真軟件multisim 10.0免費下載
  8. 340992  |  191390次下載  |  10 積分
  9. 5十天學(xué)會AVR單片機與C語言視頻教程 下載
  10. 158M  |  183342次下載  |  10 積分
  11. 6labview8.5下載
  12. 未知  |  81588次下載  |  10 積分
  13. 7Keil工具MDK-Arm免費下載
  14. 0.02 MB  |  73815次下載  |  10 積分
  15. 8LabVIEW 8.6下載
  16. 未知  |  65989次下載  |  10 積分