Spring boot+Swagger配置無侵入式Restful接口(一)

最近一直遇到有人問我spring boot +swagger怎么配置無侵入式的restful接口,這段時間一直很忙,沒有時間,剛好星期六,趁著休息時間給大家寫個demo,在這里我就粘貼一些步驟,具體的源碼我就上傳到碼云上面吧,在這里我使用的工具是IDEA,大家可以搜搜了解下,蠻不錯的一個IDE

1.創(chuàng)建一個初始化,在這里為了節(jié)約基礎的配置我就選spring initalizr,idea在2014就已經(jīng)支持了,選擇下一步,然后進行一系列選擇


2.為了快速,我就不選數(shù)據(jù)庫那些,只選擇一個web,如果需要數(shù)據(jù)庫的話,無論是關系型數(shù)據(jù)庫還是非關系型數(shù)據(jù)庫,支持得都還好

3.項目基礎結構如下,因為自帶有maven的操作,我就把這邊的文件刪除掉


4.添加swagger的依賴,其實頁面返回的時候是json格式,還需要添加jackson的依賴,只是spring boot默認關系依賴就將jackson添加進來了



5.配置swagger


6.編寫測試controller,這里我們不需要對里面的controller和方法進行swagger配置,swagger會自動掃描所有的controller,如果沒有指定是請求的哪種方法,就會將七種(get,post,put,delete等等)都進行展示,如果設置了特定的請求方法,就只會展示特定的請求方法.


7.由于我其他地方使用了8080端口,所以我就使用80端口,一句話搞定,是不是特別簡單,因為springboot默認集成了tomcat等容器,至于支持的版本,可以搜下官網(wǎng)的說明文檔,要不就把tomcat升級到8.0以上,要么就手動配置tomcat的版本


8.開始運行,先clean,再package,然后再plugins里面spring-boot找到run,就可以運行了,如果你是java源文件,也可以直接找到主方法的類,run一下就okay


9.打開瀏覽器開始訪問啦 http://localhost:端口號/swagger-ui.html,我的訪問地址就是http://localhost/swagger-ui.html


10.如果正式運行項目,注釋或者去掉swagger的配置和去掉對swagger的依賴即可

11.如果大家用的是spring mvc的框架的話,我后面有時間就給寫個demo吧,其實原理也差不多,只是多個jackson的依賴,大家可以嘗試一下

12.源代碼我已上傳至碼云,鏈接地址spring boot+swagger,歡迎大家下載和交流,如果本文章有什么錯誤的地方,歡迎大家指出,謝謝!

13.如果你覺得這個還是太過麻煩了,接下來,是時候來一波大招了,??Spring boot+Swagger配置無侵入式Restful接口(二)

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

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