springboot整合swagger2

Swagger2集成SpringBoot教程

最新推荐文章于 2021-01-15 21:42:43 发布

Wheat_Liu

最新推荐文章于 2021-01-15 21:42:43 发布

阅读量118

点赞数

CC 4.0 BY-SA版权

分类专栏： Java第三方依赖

本文链接：https://blog.youkuaiyun.com/weixin_39841589/article/details/83280032

Java第三方依赖专栏收录该内容

12 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括Maven依赖配置、Swagger配置类编写及启动类注解添加，确保API文档自动生成。

maven依赖：

<swagger2.version>2.9.2</swagger2.version>
<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>

swagger2配置类：

package com.example.demo.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @ClassName SwaggerConfig
 * @Description TODO
 * @Author Fast King
 * @Date 2018/10/16 22:48
 * @Version 1.0
 **/
@Configuration
public class SwaggerConfig{

	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.select()
				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
				.build();
	}

}

springboot启动类：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class DemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}
}

注意要在类前面加@EnableSwagger2注解否则会报错：

Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gateway. The base url is the root of where all the swagger resources are served. For e.g. if the api is available at http://example.org/api/v2/api-docs then the base url is http://example.org/api/. Please enter the location manually: