springboot集成swagger

最新推荐文章于 2024-07-31 09:32:30 发布

-七秒钟记忆

最新推荐文章于 2024-07-31 09:32:30 发布

阅读量237

点赞数

CC 4.0 BY-SA版权

分类专栏： Java笔记

本文链接：https://blog.youkuaiyun.com/fishlearning/article/details/105197537

Java笔记专栏收录该内容

45 篇文章

订阅专栏

本文详细介绍了如何在项目中集成并配置Swagger2，包括下载依赖、编写配置类及控制器代码，确保API文档自动生成，方便开发者快速理解接口功能。

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

下载依赖

        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.10</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.10</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>18.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.plugin</groupId>
            <artifactId>spring-plugin-metadata</artifactId>
            <version>1.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.plugin</groupId>
            <artifactId>spring-plugin-core</artifactId>
            <version>1.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.0.0.Final</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.fasterxml</groupId>
            <artifactId>classmate</artifactId>
            <version>1.2.0</version>
        </dependency>
        <!--json-->
        <dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <version>2.4</version>
            <classifier>jdk15</classifier>
        </dependency>
        <!--jackson-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.6.5</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.6.5</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.6.5</version>
        </dependency>

编写配置类

/**
 * 原生swagger2(没有token,没有header)
 * @author
 */
@Configuration
@EnableSwagger2
@EnableWebMvc
@ComponentScan(basePackages = "com.example.controller")
public class SwaggerConfig {

    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }
    private ApiInfo apiInfo() {
        Contact contact = new Contact("swagger", "xxxx","xxx@qq.com");
        return new ApiInfoBuilder().title("api接口").description("api接口").contact(contact).version("1.1.0").build();
    }

controller代码

@Controller
@RequestMapping("/testSwagger")
@Api(value = "testSwagger",description = "接口描述")
public class TestSwagger {

    @RequestMapping(value = "test",method = RequestMethod.POST,produces = {"application/json;charset=utf-8","application/xml"})
    @ResponseBody
    @ApiOperation(value = "测试",httpMethod = "POST",notes = "获取字符串")
    public String test(@ApiParam(required = true,name = "name",value = "请求路径") @RequestParam(value = "name")  String name){

        return name;
    }


}

启动项目测试
http://localhost:8989/swagger/swagger-ui.html
会报404错误,是因为:

Spring Boot自动配置本身不会自动把/swagger-ui.html这个路径映射到对应的目录META-INF/resources/下面。我们加上这个映射即可。

@Configuration
  class WebMvcConfig extends WebMvcConfigurerAdapter {
      @Override
      public void addResourceHandlers(ResourceHandlerRegistry registry) {
                 registry.addResourceHandler("swagger-ui.html")
                         .addResourceLocations("classpath:/META-INF/resources/");

                 registry.addResourceHandler("/webjars/**")
                         .addResourceLocations("classpath:/META-INF/resources/webjars/");
            }
 }