Spring Mvc和SpringBoot整合Swagger2


各位同窗你們好,最近項目趕進度,沒有鑽研技術的時間,但碰巧今天須要在Spring項目上進行SpringMvc和Swagger的整合,而第一次使用Swagger是在SpringBoot項目上,所以踩了很多的坑,因而想和你們分享一下
:關於Swagger在SpringBoot或者和SpringMvc的集成!html


隨着開發模式逐漸向先後端分離演變,溝通的成本逐漸增長,前端和後端的惟一聯繫,變成了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系用的挺多。工業上應該不咋用。json

 

swagger如今有兩個版本,同時對應兩種集成方式;版本1的swagger須要下載swagger-ui項目並導入本身的項目,致使項目臃腫且如今已不支持使用;所以咱們如今的集成是對swagger2而言;首先,英文名男咱們先講解SpringBoot項目下的集成。後端

 

這裏寫圖片描述

這裏寫圖片描述

 

 

這裏寫圖片描述


好了,作到這,關於swagger的集成算是完成了!有空也能夠去研究一下swagger的其餘用法,畢竟它仍是能提升咱們的開發效率。框架

相關文章
相關標籤/搜索