Swagger2配置（代码直接可用）

枫陵

已于 2022-03-26 20:53:33 修改

阅读量503

点赞数 4

文章标签： java

于 2022-03-26 20:14:45 首次发布

本文链接：https://blog.csdn.net/weixin_43899792/article/details/123762344

版权

一. 添加依赖

  <!-- swagger2 依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- Swagger第三方ui依赖 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

二. Swagger2配置文件

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxxx.server.controller"))//controller层对应位置
                .paths(PathSelectors.any())
                .build();
                
    }

    //设置文档信息
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("xxx接口文档")
                .description("xxx接口文档")
                .contact(new Contact("xxxx","http:localhost:8081/doc.html","xxx@xxx.com")) 
                .version("1.0")
                .build();
    }



}

三. 查看结果

登录自己设置的网址查看文档（本文设置的是http:localhost:8081/doc.html）

四. 验证测试

编写测试controller

@Api(tags = "描述类的注解")
@RestController
public class HelloController {

    @ApiOperation("描述方法或接口的注解")
    @GetMapping("hello")
    public String hello(){
        return "hello";
    }

}

查看文档

验证调试结果