SpringBoot整合swagger

原创于 2022-06-01 00:36:54 发布 · 121 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

SpringBoot 专栏收录该内容

20 篇文章

订阅专栏

本文档介绍了如何在SpringBoot项目中整合Swagger，用于生成RESTful API的交互文档。通过添加Swagger依赖，配置SwaggerConfig，并使用注解@Api、@ApiOperation和@ApiParam为接口和参数添加说明。最终，可以通过http://localhost:port/swagger-ui.html访问生成的API文档。

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

SpringBoot整合Swagger

导入依赖

 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <scope>provided</scope>
 </dependency>
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <scope>provided</scope>
 </dependency>

配置Swagger

package com.vmware.service;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*"))) //排除路径
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("b", "http://xxx.com",
                        "3330342452@qq.com"))
                .build();
    }
}

访问Swagger

http://localhost:prot/swagger-ui.html

定义接口说明和参数说明

定义在类上： @Api
定义在方法上：@ApiOperation
定义在参数上：@ApiParam