第解決springboot引入swagger2不生效問(wèn)題目錄問(wèn)題描述：springboot引入swagger2的步驟：①引入依賴②編寫Swagger2的配置類③在controller中添加注解：按需添加注解④在model（pojo）上加注解，按需添加一些注解的使用今天遇到跟同事遇到一個(gè)由于失誤導(dǎo)致的問(wèn)題，也可以說(shuō)比較難發(fā)現(xiàn)了.在此記錄一下（我們用的springboot是2.0.3，swagger是2.2.2）

問(wèn)題描述：

swagger修改title,description等都不生效。并且啟動(dòng)springboot，沒(méi)有有去加載swagger的配置類。（在debug模式啟動(dòng))

經(jīng)過(guò)不斷的查找，發(fā)現(xiàn)了原因是：swagger的配置類的注解加錯(cuò)了。@Configuration不小心寫成了@Configurable.

還有就是@EnableSwagger2注解只需要加在swagger配置類上

springboot引入swagger2的步驟：

①引入依賴

!--引入swagger包--

dependency

groupIdio.springfox/groupId

artifactIdspringfox-swagger2/artifactId

version2.2.2/version

/dependency

dependency

groupIdio.springfox/groupId

artifactIdspringfox-swagger-ui/artifactId

version2.2.2/version

/dependency

②編寫Swagger2的配置類

@Configuration

@EnableSwagger2

publicclassSwagger2Config{

@Bean

publicDocketapi(){

returnnewDocket(DocumentationType.SWAGGER_2)

.apiInfo(getApiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.xx.controller"))

.paths(PathSelectors.any())

.build();

privateApiInfogetApiInfo(){

returnnewApiInfoBuilder()

.title("Swagger2....")

.description("Swagger2")

.version("1.0")

.license("Apache2.0")

.licenseUrl("/licenses/LICENSE-2.0")

.build();

③在controller中添加注解：按需添加注解

@Controller

@RequestMapping("/user")

@Api(tags="我的接口模塊")

publicclassUserController{

@Autowired

privateUserServiceuserService;

//注意這個(gè)注解跟請(qǐng)求對(duì)應(yīng)的@XxxMapping，要不然這個(gè)接口會(huì)生成好多方法

@GetMapping(value="/getUserById")

@ResponseBody

@ApiOperation(value="根據(jù)ID查詢User")

publicUsergetUserById(@RequestParam(value="id")intid){

returnuserService.getUserById(id);

④在model（pojo）上加注解，按需添加

@ApiModel(value="用戶對(duì)象")

publicclassUser{

@ApiModelProperty(value="用戶ID",name="userId")

privateIntegeruserId;

@ApiModelProperty(value="用戶姓名",name="userName")

privateStringuserName;

@ApiModelProperty(value="用戶密碼",name="password")

privateStringpassword;

@ApiModelProperty(value="用戶手機(jī)號(hào)",name="phone")

privateStringphone;

一些注解的使用

@Api：一般用于Controller中,用于接口分組

@ApiOperation：接口說(shuō)明,用于api方法上。

@ApiImplicitParams：用在方法上包含一組參數(shù)說(shuō)明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面

paramType：參數(shù)放在哪個(gè)地方

header請(qǐng)求參數(shù)的獲?。篅RequestHeader

query請(qǐng)求參數(shù)的獲?。篅RequestParam

path（用于restful接口）請(qǐng)求參數(shù)的獲?。篅PathVariable

body（不常用）

form（不常用）

name：參數(shù)名

dataType：參數(shù)類型

required：參數(shù)是否必須傳

value：參數(shù)的意思

defaultValue：參數(shù)的默認(rèn)值

@ApiResponses：用于表示一組響應(yīng)

@ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息

code：數(shù)字，例如400

message：信息#xff0c;例如請(qǐng)求參數(shù)沒(méi)填好

response：拋出異常的類

@ApiModel：描述一個(gè)Model的信息（這種一般用在post創(chuàng)建的時(shí)候，使用@RequestBody這樣的場(chǎng)景，請(qǐng)求參數(shù)無(wú)法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）表明這是一個(gè)被swagger