SpringBoot集成SwaggerUI

Swagger是當前最好用的Restful API文檔生成的開源項目担猛,通過swagger-spring項目,實現(xiàn)了與SpingMVC框架的無縫集成功能扯键,方便生成spring restful風格的接口文檔盼忌,同時swagger-ui還可以測試spring restful風格的接口功能藏斩。其官方網(wǎng)站為:http://swagger.io/

項目環(huán)境:

  • jdk1.8
  • SpringBoot1.5.3
  • swagger2

效果圖

效果圖

首先添加依賴

<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>

將注解添加到WebConfiguration的類上娇哆。

@Configuration
@EnableSwagger2
public class WebConfiguration extends WebMvcConfigurerAdapter{
    
}

Springfox會和一組Docket協(xié)同工作馋艺,所以需要在類中定義為bean嚎卫。

@SpringBootApplication
public class SpringbootSwaggerApplication {

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

    @Bean
    public Docket useApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .paths(path -> path.startsWith("/api/"))
                .build();
    }
}

Controller層

簡單的curd接口嘉栓。

@RestController
@RequestMapping("/api")
public class UserInfoController {

    @Autowired
    private UserInfoService userInfoService;


    @RequestMapping(value = "/users", method = RequestMethod.GET)
    public List<UserInfo> findAll() {
        return userInfoService.findAll();
    }

    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public UserInfo findOne(@PathVariable("id") String id) {
        return userInfoService.findOne(id);
    }

    @RequestMapping(value = "/user", method = RequestMethod.POST)
    public UserInfo createUserInfo(UserInfo userInfo) {
        return userInfoService.save(userInfo);
    }

    @RequestMapping(value = "/user/{id}", method = RequestMethod.PUT)
    public UserInfo updateUserInfo(@PathVariable("id") String id, UserInfo userInfo) {
        return userInfoService.update(id, userInfo);
    }

    @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
    public void delete(@PathVariable("id") String id) {
        userInfoService.delete(id);
    }
}

最簡單的搭建方法到此結(jié)束,有興趣的朋友的可以去瀏覽下官網(wǎng)

項目地址:https://github.com/huangbuhuan/springboot

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末拓诸,一起剝皮案震驚了整個濱河市侵佃,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌奠支,老刑警劉巖馋辈,帶你破解...
    沈念sama閱讀 222,729評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異倍谜,居然都是意外死亡迈螟,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,226評論 3 399
  • 文/潘曉璐 我一進店門尔崔,熙熙樓的掌柜王于貴愁眉苦臉地迎上來答毫,“玉大人,你說我怎么就攤上這事季春∠绰В” “怎么了?”我有些...
    開封第一講書人閱讀 169,461評論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長耘拇。 經(jīng)常有香客問我撵颊,道長,這世上最難降的妖魔是什么惫叛? 我笑而不...
    開封第一講書人閱讀 60,135評論 1 300
  • 正文 為了忘掉前任秦驯,我火速辦了婚禮,結(jié)果婚禮上挣棕,老公的妹妹穿的比我還像新娘译隘。我一直安慰自己,他們只是感情好洛心,可當我...
    茶點故事閱讀 69,130評論 6 398
  • 文/花漫 我一把揭開白布固耘。 她就那樣靜靜地躺著,像睡著了一般词身。 火紅的嫁衣襯著肌膚如雪厅目。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,736評論 1 312
  • 那天法严,我揣著相機與錄音损敷,去河邊找鬼。 笑死深啤,一個胖子當著我的面吹牛拗馒,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播溯街,決...
    沈念sama閱讀 41,179評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼诱桂,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了呈昔?” 一聲冷哼從身側(cè)響起挥等,我...
    開封第一講書人閱讀 40,124評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎堤尾,沒想到半個月后肝劲,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,657評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡郭宝,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,723評論 3 342
  • 正文 我和宋清朗相戀三年辞槐,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片剩蟀。...
    茶點故事閱讀 40,872評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡催蝗,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出育特,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 36,533評論 5 351
  • 正文 年R本政府宣布缰冤,位于F島的核電站犬缨,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏棉浸。R本人自食惡果不足惜怀薛,卻給世界環(huán)境...
    茶點故事閱讀 42,213評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望迷郑。 院中可真熱鬧枝恋,春花似錦、人聲如沸嗡害。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,700評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽霸妹。三九已至十电,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間叹螟,已是汗流浹背鹃骂。 一陣腳步聲響...
    開封第一講書人閱讀 33,819評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留罢绽,地道東北人畏线。 一個月前我還...
    沈念sama閱讀 49,304評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像良价,于是被迫代替她去往敵國和親象踊。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,876評論 2 361

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