4 使用swagger2輕松生成在線接口文檔

swagger的由來

隨著互聯網技術的發(fā)展故觅,現在的網站架構基本都由原來的后端渲染君账,變成了:前端渲染、先后端分離的形態(tài)榴鼎,而且前端技術和后端技術在各自的道路上越走越遠。
前端和后端的唯一聯系晚唇,變成了API接口巫财;API文檔變成了前后端開發(fā)人員聯系的紐帶,變得越來越重要哩陕,swagger就是一款讓你更好的書寫API文檔的框架平项。

其他API文檔工具

  • confluence
  • README.md
  • rap——API文檔工具,阿里開發(fā)悍及,rap2官網
  • swagger——API文檔框架闽瓢,swagger官網

swagger生態(tài)圖

swagger生態(tài)圖

swagger UI 使用方法(選了一種適度封裝之后的)

  • 在pom.xml中引入依賴
   <dependency>
      <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.8.0.RELEASE</version>
      </dependency>
  • 在應用主類中增加@EnableSwagger2Doc注解
@SpringBootApplication
@EnableSwagger2Doc
public class Springboot2Swagger2Application {

    public static void main(String[] args) {
        SpringApplication.run(Springboot2Swagger2Application.class, args);
    }
}

默認情況下就能產生所有當前SpringMVC加載的請求映射文檔

訪問地址:http://localhost:8080/swagger-ui.html

  • 參數配置示例
swagger.enabled=true
swagger.title=spring-data-jpa module
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=mqXu
swagger.contact.url=http://www.reibang.com/u/822585e5c69a
swagger.contact.email=moqi1977@gmail.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

swagger UI整體效果

swagger-ui頁面

這下,離開postman也可以愉快地測試接口了并鸵,并且很方便地生成了在線的接口文檔鸳粉,方便前后端聯調扔涧,再也不會滯后了园担。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市枯夜,隨后出現的幾起案子弯汰,更是在濱河造成了極大的恐慌,老刑警劉巖湖雹,帶你破解...
    沈念sama閱讀 217,542評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件咏闪,死亡現場離奇詭異,居然都是意外死亡摔吏,警方通過查閱死者的電腦和手機鸽嫂,發(fā)現死者居然都...
    沈念sama閱讀 92,822評論 3 394
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來征讲,“玉大人据某,你說我怎么就攤上這事∈浚” “怎么了癣籽?”我有些...
    開封第一講書人閱讀 163,912評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我筷狼,道長瓶籽,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,449評論 1 293
  • 正文 為了忘掉前任埂材,我火速辦了婚禮塑顺,結果婚禮上,老公的妹妹穿的比我還像新娘俏险。我一直安慰自己茬暇,他們只是感情好,可當我...
    茶點故事閱讀 67,500評論 6 392
  • 文/花漫 我一把揭開白布寡喝。 她就那樣靜靜地躺著糙俗,像睡著了一般。 火紅的嫁衣襯著肌膚如雪预鬓。 梳的紋絲不亂的頭發(fā)上巧骚,一...
    開封第一講書人閱讀 51,370評論 1 302
  • 那天,我揣著相機與錄音格二,去河邊找鬼劈彪。 笑死,一個胖子當著我的面吹牛顶猜,可吹牛的內容都是我干的沧奴。 我是一名探鬼主播,決...
    沈念sama閱讀 40,193評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼长窄,長吁一口氣:“原來是場噩夢啊……” “哼滔吠!你這毒婦竟也來了?” 一聲冷哼從身側響起挠日,我...
    開封第一講書人閱讀 39,074評論 0 276
  • 序言:老撾萬榮一對情侶失蹤疮绷,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后嚣潜,有當地人在樹林里發(fā)現了一具尸體冬骚,經...
    沈念sama閱讀 45,505評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,722評論 3 335
  • 正文 我和宋清朗相戀三年懂算,在試婚紗的時候發(fā)現自己被綠了只冻。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,841評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡计技,死狀恐怖喜德,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情酸役,我是刑警寧澤住诸,帶...
    沈念sama閱讀 35,569評論 5 345
  • 正文 年R本政府宣布驾胆,位于F島的核電站,受9級特大地震影響贱呐,放射性物質發(fā)生泄漏丧诺。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,168評論 3 328
  • 文/蒙蒙 一驳阎、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧馁蒂,春花似錦呵晚、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至沮脖,卻和暖如春金矛,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背勺届。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評論 1 269
  • 我被黑心中介騙來泰國打工驶俊, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人免姿。 一個月前我還...
    沈念sama閱讀 47,962評論 2 370
  • 正文 我出身青樓饼酿,卻偏偏與公主長得像,于是被迫代替她去往敵國和親胚膊。 傳聞我的和親對象是個殘疾皇子故俐,可洞房花燭夜當晚...
    茶點故事閱讀 44,781評論 2 354