springboot集成swagger2

IT雪

已于 2023-10-19 14:25:37 修改

阅读量578

点赞数

文章标签： java bootstrap 开发语言

于 2021-11-10 09:48:19 首次发布

本文链接：https://blog.youkuaiyun.com/qq_38709565/article/details/121241899

版权

本文介绍了如何在Spring Boot项目中集成Swagger 2.9.2，包括添加依赖、配置Swagger2、设置application.yml、启动类启用以及在Controller层使用@Api注解。通过实例展示了如何创建API文档和自定义UI界面。

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

1.添加swagger2依赖

   <properties>
        <swagger.version>2.8.0</swagger.version>
    </properties>

        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

2.配置swagger2

@Configuration
public class Swagger2 {

    @Value("${swagger.enable}")
    private boolean enableSwagger;

    @Bean
    public Docket api() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()).enable(enableSwagger)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("本地测试Demo")
                .description("")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }

}

3.配置application.yml文件

swagger:
  enable: true

4.配置启动类

@EnableSwagger2
@EnableSwaggerBootstrapUI
@SpringBootApplication
@MapperScan("com.example.demo.*.mapper")
public class DemoApplication  {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

5.在controller层添加标签：@api

@RequestMapping("/hello")
@Api(value = "您好", tags = "测试")
@RestController
public class HelloController {


    @GetMapping("sayHello")
    public String hello(){
        return "hello wangxue";
    }

    @GetMapping("insert")
    public void insert(){

    }
}

这个注解有两个参数：value、tags