springboot-swagger實戰(zhàn)淺析

接口管理的強大工具麦轰。demo地址在文章最后

項目現(xiàn)在前后端分離,需要一個API的管理工具翁巍,在分析了如下幾個最終選擇了,swagger休雌。比較主流的方式灶壶。

API管理

  • swagger
  • RAP 阿里出品,以開發(fā)為核心對接口維護
  • POSTMAN
  • DOClever 可視化接口管理工具杈曲,分析接口驰凛,校驗接口,采用了JavaScript

十分鐘搭建以springboot為項目的API管理

demo為第二種方式担扑,也是官方推薦

第一步

添加maven包

第一種方式:
<!-- https://mvnrepository.com/artifact/com.mangofactory/swagger-springmvc -->
<dependency>
    <groupId>com.mangofactory</groupId>
    <artifactId>swagger-springmvc</artifactId>
    <version>1.0.2</version>
</dependency>

第二種方式
 <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

官方建議是swagger2

第二步驟

添加Configuration配置

package com.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket swaggerSpringMvcPlugin(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("springboot利用swagger構建api文檔")
                .description("簡單優(yōu)雅的restfun風格")
                .version("1.0")
                .build();

    }

}

第三步

啟動springboot項目恰响,訪問:localhost:

http://localhost:9999/swagger-ui.html
swagger

springboot-swagger

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市涌献,隨后出現(xiàn)的幾起案子胚宦,更是在濱河造成了極大的恐慌,老刑警劉巖燕垃,帶你破解...
    沈念sama閱讀 206,839評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件枢劝,死亡現(xiàn)場離奇詭異,居然都是意外死亡卜壕,警方通過查閱死者的電腦和手機您旁,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來轴捎,“玉大人鹤盒,你說我怎么就攤上這事蚕脏。” “怎么了侦锯?”我有些...
    開封第一講書人閱讀 153,116評論 0 344
  • 文/不壞的土叔 我叫張陵驼鞭,是天一觀的道長。 經(jīng)常有香客問我尺碰,道長终议,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,371評論 1 279
  • 正文 為了忘掉前任葱蝗,我火速辦了婚禮,結果婚禮上细燎,老公的妹妹穿的比我還像新娘两曼。我一直安慰自己,他們只是感情好玻驻,可當我...
    茶點故事閱讀 64,384評論 5 374
  • 文/花漫 我一把揭開白布悼凑。 她就那樣靜靜地躺著,像睡著了一般璧瞬。 火紅的嫁衣襯著肌膚如雪户辫。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,111評論 1 285
  • 那天嗤锉,我揣著相機與錄音渔欢,去河邊找鬼。 笑死瘟忱,一個胖子當著我的面吹牛奥额,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播访诱,決...
    沈念sama閱讀 38,416評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼垫挨,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了触菜?” 一聲冷哼從身側響起九榔,我...
    開封第一講書人閱讀 37,053評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎涡相,沒想到半個月后哲泊,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,558評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡催蝗,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,007評論 2 325
  • 正文 我和宋清朗相戀三年攻旦,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片生逸。...
    茶點故事閱讀 38,117評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡牢屋,死狀恐怖且预,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情烙无,我是刑警寧澤锋谐,帶...
    沈念sama閱讀 33,756評論 4 324
  • 正文 年R本政府宣布,位于F島的核電站截酷,受9級特大地震影響涮拗,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜迂苛,卻給世界環(huán)境...
    茶點故事閱讀 39,324評論 3 307
  • 文/蒙蒙 一三热、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧三幻,春花似錦就漾、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至朗徊,卻和暖如春首妖,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背爷恳。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評論 1 262
  • 我被黑心中介騙來泰國打工有缆, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人温亲。 一個月前我還...
    沈念sama閱讀 45,578評論 2 355
  • 正文 我出身青樓妒貌,卻偏偏與公主長得像,于是被迫代替她去往敵國和親铸豁。 傳聞我的和親對象是個殘疾皇子灌曙,可洞房花燭夜當晚...
    茶點故事閱讀 42,877評論 2 345

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