web结构的mvc项目集成swagger

最新推荐文章于 2025-06-19 14:49:32 发布

原创最新推荐文章于 2025-06-19 14:49:32 发布 · 759 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

swagger 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何在Spring MVC项目中集成Swagger2.5，包括导入必要的jar包、编写SwaggerConfig、配置XML文件以及处理资源文件过滤。适合web开发者参考实现API文档生成与管理。

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

文章目录

前言
一、导入jar包
二、编写SwaggerConfig
三.配置xml
四.过滤资源文件

前言

先说一下我的项目是web结构的mvc项目，在网上看了很多集成的教程都是maven结构的mvc项目。所以自己摸着石头过河，目前已搭建好了，所以记录下供后人参考。

提示：以下是本篇文章正文内容，下面案例可供参考

一、导入jar包

jar包这里找了半天。 swagger2.5所有jar包

二、编写SwaggerConfig

代码如下（示例）：

package com.huiyu.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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
@EnableWebMvc
public class SwaggerConfig {

    @Bean
    public Docket userApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("用户")
                .select()  // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.basePackage("com.huiyu.echart.controller"))
                .paths(PathSelectors.any()) // 对所有路径进行监控
                .build()
                .apiInfo(userInfo());
    }



    private ApiInfo userInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")//文档说明
                .version("1.0")//文档版本说明
                .build();
    }

}

编写好之后需要加入
在这里插入图片描述

三.配置xml

代码如下（示例）：在mvc.xml中加入

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

在这里插入图片描述

spring-package.xml 加入包扫描

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

在项目中用shiro的，需要配置免登入
在这里插入图片描述

四.过滤资源文件

在这里插入图片描述

  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.html</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.css</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.ico</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.gif</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.png</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.jpg</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.woff</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.ttf</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.svg</url-pattern>
  </servlet-mapping>