Swagger UI怎么支持Laravel的CSRF Token?

有些同學在做前后端分離項目時用Swagger UI會碰到沒有CSRF Token的報錯,本文給出了支持CSRF Token的思路,其實很簡單。

另外,當前Swagger UI已經更新到了3.x版本,截止到目前為止官方還沒確定地給出好的方案(有討論在這里),不過看節奏應該在六月份內,所以我也不打算研究比較Hack的方法,但如果你正好做過,歡迎在評論中給大家分享。3.x是一個重構的版本,底層更統一不過還有待增強功能,靜待官方繼續努力。

Swagger UI 版本 2.x

思路真的很簡單。按照Laravel官方文檔所說,在前端發起請求的時候附帶一個請求頭(Header)就行了。如果Swagger UI的界面是PHP輸出的則最好辦,示例如下:


// 省略若干行...

<!-- 添加下面這行到Swagger UI的Blade模版中<head>標簽中 -->
<meta name="csrf-token" content="{{ csrf_token() }}">

// 省略若干行...

<script>

// 省略若干行...

window.swaggerUi.load();

// 添加下面這段代碼到"window.swaggerUi.load();"的后面
swaggerUi.api.clientAuthorizations.add(
    "X-CSRF-TOKEN", 
    new SwaggerClient.ApiKeyAuthorization(
        "X-CSRF-TOKEN", 
        $('meta[name="csrf-token"]').attr('content'),
        "header"
    )
);

// 省略若干行...

</script>

Swagger UI的API文檔在這里。

如果Swagger UI不是由PHP渲染輸出就比較麻煩了,能改代碼的話,可以讓前端自動設置Token,不然看看關于Swagger授權相關開發方法也許能夠曲線救國實現。

Swagger UI 版本 3.x

關注這里

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,797評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,179評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 175,628評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,642評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,444評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,948評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,040評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,185評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,717評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,794評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,418評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,414評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,750評論 2 370

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,601評論 25 707
  • 情絲斷離, 思念殘碎、 離別之愁、 望遠相思、 斬斷今世宿緣、 斷別我們的遇見、 封心殘魂、 只留一雙眼望著一望無...
    三笑草人閱讀 219評論 0 0
  • 1、感恩父母給予我生命。 2、感恩祖輩將我養育。 3、感恩母親與祖母為家做出的巨大付出。 4、感恩妻子一直的包容與...
    朱曉軍閱讀 186評論 0 2
  • 如何才能找到一個優秀的配偶,最好的方式就是讓自己配得上她/他,因為優秀配偶都不是傻瓜。 聽過太多美好的婚姻關系是大...
    隔著銀河閱讀 248評論 0 0
  • 導讀 新房裝修中,無論空間的巨細是多少,書房的安置都應該是舒服高雅的,書房的首要作用則是供家人工作和學習的當地,也...
    業主之家閱讀 372評論 0 2