swagger接口文檔生成工具

文章首推

• 支付寶接口對接
• 高德地圖調(diào)用
• 驗(yàn)證碼登錄
• QQ郵箱登錄

簡介

在一個(gè)大的的項(xiàng)目中可能會有很多控制類，每個(gè)控制類中會有很多方法，這時(shí)候我們需要一個(gè)接口文檔生成工具來暴露這些接口，方便我們進(jìn)行直接查找測試，確實(shí)是方便了很多，那么來學(xué)習(xí)一下吧

環(huán)境

• springboot
• swagger2.x

實(shí)現(xiàn)過程

1、創(chuàng)建一個(gè)springboot項(xiàng)目工程,添加依賴

????????
????????????io.springfox
????????????springfox-swagger-ui
????????????2.4.0
????????
????????
????????????io.springfox
????????????springfox-swagger2
????????????2.4.0
????????

2、添加配置文件

//swagger2的配置文件，在項(xiàng)目的啟動(dòng)類的同級文件建立
@Configuration
@EnableSwagger2
public?class?SwaggerConfig?{

????@Bean
????public?Docket?api()?{
????????return?new?Docket(DocumentationType.SWAGGER_2)
????????????????.select()??//?選擇那些路徑和api會生成document
????????????????.apis(RequestHandlerSelectors.any())?//?對所有api進(jìn)行監(jiān)控
????????????????.paths(PathSelectors.any())?//?對所有路徑進(jìn)行監(jiān)控
????????????????.build();
????}

}

3、準(zhǔn)備控制類

@PostMapping("/hello")
????@ApiOperation(value?=?"測試",notes?=?"這是一個(gè)測試文檔")
????public?String?hello(){
????????return?"hello";
????}

4、啟動(dòng)項(xiàng)目，訪問地址：http://localhost:端口/swagger-ui.html/這里可以進(jìn)行測試

Swagger全部是以JSON的格式向后臺傳參的

這是非常重要的一點(diǎn)，我自己找了很多文章才發(fā)現(xiàn)的，入?yún)⒍际且詊son格式的，也就是說只支持@RequestBody的入?yún)ⅰ?/p>

想下面這個(gè)就不行：

@GetMapping("/test")
????public?String?test(String?test){
????????return?test;
????}

大家可以看到響應(yīng)體是no content其實(shí)這里也已經(jīng)給我們答案了，參數(shù)類型只支持json格式

請給鵬哥點(diǎn)個(gè)在看吧