電子發(fā)燒友App

硬聲App

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

完善資料讓更多小伙伴認識你,還能領取20積分哦,立即完善>

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

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

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

資料介紹

授權協(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'             => '基礎信息',
            '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'    => '權限',
            'NeedLogin'        => '登錄',
            'NeedRight'        => '鑒權',
            'ReturnHeaders'    => '響應頭',
            'ReturnParameters' => '返回參數(shù)',
            'Response'         => '響應輸出',
        ];
        $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 對應的控制器自然是 admin下的api控制器啦

控制器注釋

名稱 描述 示例
@ApiSector API分組名稱 (測試分組)
@ApiRoute API接口URL,此@ApiRoute只是基礎URL (/api/test)
@ApiInternal 忽略的控制器,表示此控制將不加入API文檔
@ApiWeigh API方法的排序,值越大越靠前 (99)

控制器方法注釋

名稱 描述 示例
@ApiTitle API接口的標題,為空時將自動匹配注釋的文本信息 (測試標題)
@ApiSummary API接口描述 (測試描述)
@ApiRoute API接口地址,為空時將自動計算請求地址 (/api/test/index)
@ApiMethod API接口請求方法,默認為GET (POST)
@ApiSector API分組,默認按鈕控制器或控制器的@ApiSector進行分組 (測試分組)
@ApiParams API請求參數(shù),如果在@ApiRoute中有對應的{@參數(shù)名},將進行替換 (, , required=true, )
@ApiHeaders API請求傳遞的Headers信息 (name=token, type=string, required=true, )
@ApiReturn API返回的結果示例 ({"code":1,"msg":"返回成功"})
@ApiReturnParams API返回的結果參數(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'];
    // 無需要判斷權限規(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. 1山景DSP芯片AP8248A2數(shù)據(jù)手冊
  2. 1.06 MB  |  532次下載  |  免費
  3. 2RK3399完整板原理圖(支持平板,盒子VR)
  4. 3.28 MB  |  339次下載  |  免費
  5. 3TC358743XBG評估板參考手冊
  6. 1.36 MB  |  330次下載  |  免費
  7. 4DFM軟件使用教程
  8. 0.84 MB  |  295次下載  |  免費
  9. 5元宇宙深度解析—未來的未來-風口還是泡沫
  10. 6.40 MB  |  227次下載  |  免費
  11. 6迪文DGUS開發(fā)指南
  12. 31.67 MB  |  194次下載  |  免費
  13. 7元宇宙底層硬件系列報告
  14. 13.42 MB  |  182次下載  |  免費
  15. 8FP5207XR-G1中文應用手冊
  16. 1.09 MB  |  178次下載  |  免費

本月

  1. 1OrCAD10.5下載OrCAD10.5中文版軟件
  2. 0.00 MB  |  234315次下載  |  免費
  3. 2555集成電路應用800例(新編版)
  4. 0.00 MB  |  33566次下載  |  免費
  5. 3接口電路圖大全
  6. 未知  |  30323次下載  |  免費
  7. 4開關電源設計實例指南
  8. 未知  |  21549次下載  |  免費
  9. 5電氣工程師手冊免費下載(新編第二版pdf電子書)
  10. 0.00 MB  |  15349次下載  |  免費
  11. 6數(shù)字電路基礎pdf(下載)
  12. 未知  |  13750次下載  |  免費
  13. 7電子制作實例集錦 下載
  14. 未知  |  8113次下載  |  免費
  15. 8《LED驅動電路設計》 溫德爾著
  16. 0.00 MB  |  6656次下載  |  免費

總榜

  1. 1matlab軟件下載入口
  2. 未知  |  935054次下載  |  免費
  3. 2protel99se軟件下載(可英文版轉中文版)
  4. 78.1 MB  |  537798次下載  |  免費
  5. 3MATLAB 7.1 下載 (含軟件介紹)
  6. 未知  |  420027次下載  |  免費
  7. 4OrCAD10.5下載OrCAD10.5中文版軟件
  8. 0.00 MB  |  234315次下載  |  免費
  9. 5Altium DXP2002下載入口
  10. 未知  |  233046次下載  |  免費
  11. 6電路仿真軟件multisim 10.0免費下載
  12. 340992  |  191187次下載  |  免費
  13. 7十天學會AVR單片機與C語言視頻教程 下載
  14. 158M  |  183279次下載  |  免費
  15. 8proe5.0野火版下載(中文版免費下載)
  16. 未知  |  138040次下載  |  免費