一、導(dǎo)入maven包　

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

二、添加工具類(lèi)

@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2).pathMapping('/').select().apis(RequestHandlerSelectors.basePackage('com.nvn.controller')).paths(PathSelectors.any()).build().apiInfo(new ApiInfoBuilder() .title('SpringBoot整合Swagger') .description('SpringBoot整合Swagger，詳細(xì)信息......') .version('1.0') .build()); }}

三、添加注解

@RestController@Api(tags = '用戶管理相關(guān)接口')@RequestMapping('/user')public class UserController { @PostMapping('/') @ApiOperation('添加用戶的接口') @ApiImplicitParams({ @ApiImplicitParam(name = 'username', value = '用戶名', defaultValue = '李四'), @ApiImplicitParam(name = 'address', value = '用戶地址', defaultValue = '深圳', required = true) } ) public RespBean addUser(String username, @RequestParam(required = true) String address) { return new RespBean(); } @GetMapping('/') @ApiOperation('根據(jù)id查詢用戶的接口') @ApiImplicitParam(name = 'id', value = '用戶id', defaultValue = '99', required = true) public User getUserById(@PathVariable Integer id) { User user = new User(); user.setId(id); return user; } @PutMapping('/{id}') @ApiOperation('根據(jù)id更新用戶的接口') public User updateUserById(@RequestBody User user) { return user; }}

四、注解說(shuō)明

@Api注解可以用來(lái)標(biāo)記當(dāng)前Controller的功能。 @ApiOperation注解用來(lái)標(biāo)記一個(gè)方法的作用。 @ApiImplicitParam注解用來(lái)描述一個(gè)參數(shù)，可以配置參數(shù)的中文含義，也可以給參數(shù)設(shè)置默認(rèn)值，這樣在接口測(cè)試的時(shí)候可以避免手動(dòng)輸入。 如果有多個(gè)參數(shù)，則需要使用多個(gè)@ApiImplicitParam注解來(lái)描述，多個(gè)@ApiImplicitParam注解需要放在一個(gè)@ApiImplicitParams注解中。 @ApiImplicitParam注解中雖然可以指定參數(shù)是必填的，但是卻不能代替@RequestParam(required = true)，前者的必填只是在Swagger2框架內(nèi)必填，拋棄了Swagger2，這個(gè)限制就沒(méi)用了，所以假如開(kāi)發(fā)者需要指定一個(gè)參數(shù)必填，@RequestParam(required = true)注解還是不能省略。

五、如果參數(shù)是一個(gè)對(duì)象，對(duì)于參數(shù)的描述可以放在實(shí)體類(lèi)中。

@ApiModelpublic class User { @ApiModelProperty(value = '用戶id') private Integer id; @ApiModelProperty(value = '用戶名') private String username; @ApiModelProperty(value = '用戶地址') private String address; //getter/setter}

六、效果

附：如果我們的Spring Boot項(xiàng)目中集成了Spring Security，那么如果不做額外配置，Swagger2文檔可能會(huì)被攔截，此時(shí)只需要在Spring Security的配置類(lèi)中重寫(xiě)configure方法，添加如下過(guò)濾即可：

@Overridepublic void configure(WebSecurity web) throws Exception { web.ignoring() .antMatchers('/swagger-ui.html') .antMatchers('/v2/**') .antMatchers('/swagger-resources/**');}

以上就是SpringBoot整合Swagger2的示例的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot整合Swagger2的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章！