基于Laravel構(gòu)建API文檔擴(kuò)展Swagger

介紹:

????Swagger 是一個(gè)規(guī)范和完整的框架螃宙,用于生成、描述置济、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)解恰。總體目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來(lái)更新浙于。文件的方法护盈,參數(shù)和模型緊密集成到服務(wù)器端的代碼,允許API來(lái)始終保持同步羞酗。(簡(jiǎn)單來(lái)說(shuō)就是構(gòu)建Annotation)?

? ? 首先使用composer安裝swagger-php擴(kuò)展包

????$ composer require zircote/swagger-php????

? ? 創(chuàng)建一個(gè)laravel控制器

?php artisan make:controller SwaggerController?

? ? 在控制器中寫入兩個(gè)方法(分別是getJson? getData)

<?php

namespace????App\Http\Controllers;

useIlluminate\Http\Request;

useApp\Http\Requests;

useApp\Http\Controllers\Controller;

classSwaggerControllerextendsController{

/**

? ? * 返回JSON格式的Swagger定義

? ? */

public function getJSON(){? ? }

/**

? ? * 假設(shè)是項(xiàng)目中的一個(gè)API

? ? */

public function getData(){? ? }}

配置相應(yīng)路由

<?php

Route::group(['prefix' => 'swagger'], function () {

Route::get('json', 'SwaggerController@getJSON');

Route::get('my-data', 'SwaggerController@getMyData');

})

我們先實(shí)現(xiàn)getJSON方法腐宋,使其能夠返回合法的Swagger定義:

<?php

// ... /** * 返回JSON格式的Swagger定義

* * 這里需要一個(gè)主`Swagger`定義:

* @SWG\Swagger( * @SWG\Info(

* title="我的`Swagger`API文檔",

* version="1.0.0"

* )

* )

*/

public function getJSON() {

// 你可以將API的`Swagger Annotation`寫在實(shí)現(xiàn)API的代碼旁,從而方便維護(hù)檀轨, // `swagger-php`會(huì)掃描你定義的目錄胸竞,自動(dòng)合并所有定義。這里我們直接用`Controller/` // 文件夾裤园。

$swagger = \Swagger\scan(app_path('Http/Controllers/')); return response()->json($swagger, 200); }

// ...

訪問(wèn)一下/swagger/json撤师,如果我們看到下面的返回就說(shuō)明搭建成功了:

{"swagger":"2.0","info":{"title":"\u6211\u7684`Swagger`API\u6587\u6863","version":"1.0.0"},"paths":{},"definitions":{}}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市拧揽,隨后出現(xiàn)的幾起案子剃盾,更是在濱河造成了極大的恐慌腺占,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件痒谴,死亡現(xiàn)場(chǎng)離奇詭異衰伯,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)积蔚,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門意鲸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人尽爆,你說(shuō)我怎么就攤上這事怎顾。” “怎么了漱贱?”我有些...
    開封第一講書人閱讀 165,138評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵槐雾,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我幅狮,道長(zhǎng)募强,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評(píng)論 1 295
  • 正文 為了忘掉前任崇摄,我火速辦了婚禮擎值,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘逐抑。我一直安慰自己鸠儿,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評(píng)論 6 392
  • 文/花漫 我一把揭開白布厕氨。 她就那樣靜靜地躺著捆交,像睡著了一般。 火紅的嫁衣襯著肌膚如雪腐巢。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評(píng)論 1 305
  • 那天玄括,我揣著相機(jī)與錄音冯丙,去河邊找鬼。 笑死遭京,一個(gè)胖子當(dāng)著我的面吹牛胃惜,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播哪雕,決...
    沈念sama閱讀 40,362評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼船殉,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了斯嚎?” 一聲冷哼從身側(cè)響起利虫,我...
    開封第一講書人閱讀 39,264評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤挨厚,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后糠惫,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體疫剃,經(jīng)...
    沈念sama閱讀 45,724評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年硼讽,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了巢价。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,040評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡固阁,死狀恐怖壤躲,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情备燃,我是刑警寧澤碉克,帶...
    沈念sama閱讀 35,742評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站赚爵,受9級(jí)特大地震影響棉胀,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜冀膝,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評(píng)論 3 330
  • 文/蒙蒙 一唁奢、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧窝剖,春花似錦麻掸、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至疙描,卻和暖如春诚隙,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背起胰。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工久又, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人效五。 一個(gè)月前我還...
    沈念sama閱讀 48,247評(píng)論 3 371
  • 正文 我出身青樓地消,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親畏妖。 傳聞我的和親對(duì)象是個(gè)殘疾皇子脉执,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容