1. 程式人生 > >Spring Mvc和SpringBoot整合Swagger2

Spring Mvc和SpringBoot整合Swagger2


各位同學大家好,最近專案趕進度,沒有鑽研技術的時間,但碰巧今天需要在Spring專案上進行SpringMvc和Swagger的整合,而第一次使用Swagger是在SpringBoot專案上,因此踩了不少的坑,於是想和大家分享一下
:關於Swagger在SpringBoot或者和SpringMvc的整合!


隨著開發模式逐漸向前後端分離演變,溝通的成本逐漸增加,前端和後端的唯一聯絡,變成了API介面;API文件變成了前後端開發人員聯絡的紐帶,變得越來越重要,swagger就是一款讓你更好的書寫API文件的框架。

沒有API文件工具之前,大家都是手寫API文件的,在什麼地方書寫的都有,有在confluence上寫的,有在對應的專案目錄下readme.md上寫的,每個公司都有每個公司的玩法,無所謂好壞。


書寫API文件的工具有很多,但是能稱之為“框架”的,估計也只有swagger了。
這裡寫圖片描述

下面再細看看swagger的生態的具體內容:
1. swagger-ui
這玩意兒從名字就能看出來,用來顯示API文件的。和rap不同的是,它不可以編輯。
2. swagger-editor
就是一個線上編輯文件說明檔案(swagger.json或swagger.yaml檔案)的工具,以方便生態中的其他小工具(swagger-ui)等使用。
3. swagger-validator
這個小工具是用來校驗生成的文件說明檔案是否符合語法規定的。
4. swagger-codegen
程式碼生成器,腳手架。可以根據swagger.json或者swagger.yml檔案生成指定的計算機語言指定框架的程式碼。

有一定用處,Java系用的挺多。工業上應該不咋用。

 

swagger現在有兩個版本,同時對應兩種整合方式;版本1的swagger需要下載swagger-ui專案並匯入自己的專案,導致專案臃腫且現在已不支援使用;因此我們現在的整合是對swagger2而言;首先,英文名男我們先講解SpringBoot專案下的整合。

 

這裡寫圖片描述

這裡寫圖片描述

 

 

這裡寫圖片描述


好了,做到這,關於swagger的整合算是完成了!有空也可以去研究一下swagger的其他用法,畢竟它還是能提高我們的開發效率。