spring boot 集成swagger2功能

intellij idea

spring boot

swagger2

创建spring boot项目

添加web,swagger2相关依赖 代码如下 org.springframework.boot spring-boot-starter-web io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2

创建swagger2配置类，代码如下@Configuration@EnableSwagger2public class SwaggerConfig {    @Bean    public Docket buildDocket() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(buildApiInf())                .select()                .apis(RequestHandlerSelectors                        .basePackage('com.zuli.springbootswagger.controller'))                .paths(PathSelectors.any())                .build();    }    private ApiInfo buildApiInf() {        return new ApiInfoBuilder()                .title('系统RESTful API文档')                .contact(new Contact('zuli', 'http://www.mengzhilan.top',                        '11111111111@qq.com'))                .version('1.0')                .build();    }}

添加一个UserController,代码如下，使用swagger2相关注解@RestController@RequestMapping('/users')@Api(value = '用户管理')public class UserController {    @ApiOperation(value = '获取用户信息', notes = '根据用户id获取用户信息')    @ApiImplicitParam(name = 'id', value = '用户id', required = true,            dataType = 'string', paramType = 'path')    @GetMapping('/{id}')    public @ResponseBody User getUserById(@PathVariable(value = 'id') String id) {        User user = new User();        user.setId(id);        user.setName('zuli');        user.setAge(25);        return user;    }}

启动spring boot项目

项目启动完成，端口为8080

访问localhost:8080/swagger-ui.html,在线接口文档如下图所示

添加swagger2依赖，需要了解swagger2相关注解

感谢点赞