swagger2快速搭建《一》

最新推荐文章于 2024-07-24 20:28:15 发布

郭敬仰

最新推荐文章于 2024-07-24 20:28:15 发布

阅读量720

点赞数 1

分类专栏：杂谈文章标签： java

本文链接：https://blog.csdn.net/jingyangV587/article/details/78865449

版权

杂谈专栏收录该内容

15 篇文章 2 订阅

订阅专栏

添加Swagger2依赖

 <!-- swagger-mvc -->
          <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-core</artifactId>
            <version>1.5.8</version>
          </dependency>
          <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
             <version>2.5.0</version>
          </dependency>
          <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
             <version>2.5.0</version>
          </dependency>
          <dependency>
            <groupId>com.fasterxml</groupId>
            <artifactId>classmate</artifactId>
            <version>1.3.1</version>
          </dependency>
          <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.8.7</version>
            </dependency>
          <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.8.7</version>
          </dependency>
      <!-- swagger-mvc -->

创建Swagger2的配置类

@EnableWebMvc 
@EnableSwagger2 
/*@ComponentScan(basePackages = {"com.test"})  */
@Configuration 
public class RestApiConfig extends WebMvcConfigurationSupport{ 
 
    @Bean 
    public Docket createRestApi() { 
        return new Docket(DocumentationType.SWAGGER_2) 
                .apiInfo(apiInfo()) 
                .select() 
                .apis(RequestHandlerSelectors.basePackage("com.test")) 
                .paths(PathSelectors.any()) 
                .build(); 
    } 
 
    private ApiInfo apiInfo() { 
        return new ApiInfoBuilder() 
                .title("Spring 中使用Swagger2构建RESTful APIs") 
                .termsOfServiceUrl("http://blog.csdn.net/he90227") 
                .contact("郭敬仰") 
                .version("1.0") 
                .build(); 
    } 
}

添加对swagger2静态资源的访问

<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/> 
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars

确保swagger2配置类被扫描到（假如RestApiConfig类在com.test目录下）

<context:component-scan base-package="com.test" />

实际项目中注意事项：
（1）避免swagger2静态资源被拦截掉
这里写图片描述
（2）避免请求的链接被拦截

（3）哪个包需要支持swagger2必须指定

该demo的下载地址：https://gitee.com/jingyang3877/all-examples/blob/master/jingyang3877-swagger-test-demo-master.zip