Springboot集成swagger2

最新推荐文章于 2019-05-10 11:27:52 发布

原创最新推荐文章于 2019-05-10 11:27:52 发布 · 329 阅读

0 ·

CC 4.0 BY-SA版权

JAVA 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在Spring Boot项目中集成Swagger2实现API文档自动生成。通过Gradle依赖引入springfox-swagger2和springfox-swagger-ui，并配置SwaggerConfig类指定文档信息及扫描范围。最后通过Controller展示使用@ApiOperation等注解进行接口说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

//----------------------------Graddle依赖-----------------------------------------

compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.4.0'
compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.4.0'

//-----------------------------Swagger配置---------------------------------------

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("web.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("restful api")
                .description("接口描述")
                .termsOfServiceUrl("http://localhost:9191/small")
                .contact(new Contact("chawintyan","http://localhost:9191/small/home","chawintyan@aliyun.com"))
                .version("1.0")
                .build();
    }
}

//-----------------------------Controller配置---------------------------------------

@ApiOperation(value = "获取用户列表", notes = "用来获取全部用户信息")
@ApiImplicitParam(name = "userName", value = "用户名称", required = true, dataType = "String")
@RequestMapping(value = "queryUsers", method = RequestMethod.GET)
public List<User> queryUsers(String userName){
    LOG.info("【请求用户名.{}】", userName);
    return loginService.queryUsers(userName);
}

访问地址 http://localhost:9191/small/swagger-ui.html