Spring mvc + mybatis+maven集成swagger ui自动生成api文档

本文档介绍了如何将Swagger UI集成到Spring MVC和Mybatis的项目中,以自动生成API文档。内容包括:1. 构建Spring MVC+Mybatis应用;2. 准备Swagger UI静态资源;3. 创建SwaggerConfig配置类;4. 测试并运行Swagger UI。在运行前,需修改index.html中的API地址。
摘要由CSDN通过智能技术生成

最近由于项目需要所以需要集成swagger-ui这货进行api文档自动生成的功能,才去研究了好久,当然也踩了很多坑,算是总结了一些经验,希望可以帮助需要的同学少走弯路吧!,本人语文估计没学好,有些表达或许不理想,那么可以点击【满级传送门】直接看源码!好了废话不多说了,直接上干货,开始干起来!

[Part 1]:构建Spring mvc+mybatis应用

你必须得已经构建好了一个web应用,而且这应用是可以跑起来的,就是可以从数据库获取数据返回到页面,或者从页面中可以提交数据到数据库的!这样的一个简单的架构应该没问题哈!

连接数据库配置文件(非web层)-spring-mybatis.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
   xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"  
   xmlns:context="http://www.springframework.org/schema/context"  
   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd  
   http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd  
   http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

<!-- 注入自动扫描非web层 -->
<context:component-scan base-package="org.com.swagger.code">
    <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

<context:property-placeholder location="classpath:config/jdbc.properties"/>

<!-- 数据库连接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
    <property name="driverClassName" value="${jdbc.driver}"/>
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.username}"/>
    <property name="password" value="${jdbc.password}"/>
    <!-- 配置过滤 -->
    <property name="filters" value="stat"/>
    <!-- 配置初始化大小、最小、最大 -->
    <property name="initialSize" value="10"/>
    <property name="minIdle" value="10"/>
    <property name="maxActive" value="100"/>
    <!-- 配置获取连接等待超时的时间 -->
    <property name="maxWait" value="60000"/>
    <!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 -->
    <property name="timeBetweenEvictionRunsMillis" value="60000"/>
    <!-- 配置一个连接在池中最小生存的时间,单位是毫秒 -->
    <property name="minEvictableIdleTimeMillis" value="300000"/>
    <!-- 检测连接是否有效的SQL -->
    <property name="validationQuery" value="SELECT 'x'"/>
    <property name="testWhileIdle" value="true"/>
    <property name="testOnBorrow" value="false"/>
    <property name="testOnReturn" value="false"/>
</bean>
<!-- 扫描mapper映射文件 -->   
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"></property>
    <property name="mapperLocations" value="classpath:mapper/*.xml"></property>
</bean>

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="org.com.swagger.code.dao"></property>
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>






web层配置文件-spring-mvc-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd">

    <!-- 自動掃描web層bean -->
    <context:component-scan base-package="org.com.swagger.code" use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

    <!-- 開啟註解 -->
    <context:annotation-config/>

    <!-- 配置視圖 -->
    <!-- <bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
        <property name="exposeRequestAttributes" value="true" />
        <property name="exposeSessionAttributes" value="true" />
        <property name="viewClass">
            <value>org.springframework.web.servlet.view.freemarker.FreeMarkerView</value>
        </property>
        <property name="cache"><value>true</value></property>
        <property name="prefix"><value>/WEB-INF/views/</value></property>
        <property name="suffix"><value>.ftl</value></property>
        <property name="contentType">
            <value>text/html; charset=UTF-8</value>
        </property>
    </bean> -->

    <mvc:annotation-driven />

    <!-- swagger-ui配置java类 bean -->
    <bean id="swaggerConfig" class="org.com.swagger.code.swagger.SwaggerConfig"/>

    <!-- 自动注册的SimpleUrlHandlerMapping 获取资源部分 -->
    <!-- servlet在找页面时,走的是dispatcherServlet路线。找不到的时候会报404加上这个默认的servlet时候,servlet在找不到的时候会去找静态的内容。 -->
    <mvc:default-servlet-handler/>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/"></property>
        <property name="suffix" value=".jsp"></property>
        <property name="contentType" value="text/html;charset=UTF-8"></property>
    </bean>

    <!--避免IE执行AJAX时,返回JSON出现下载文件 -->  
     <bean id="fastJsonHttpMessageConverter"
                  class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
          <property name="supportedMediaTypes">
               <list>
                <value>application/json;charset=UTF-8</value>
               </list>
          </property>
     </bean> 
    <!-- 启动SpringMVC的注解功能,完成请求和注解POJO的映射 -->  
    <bean  
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
        <property name="messageConverters">  
            <list>  
                <ref bean="fastJsonHttpMessageConverter" /> <!-- JSON转换器 -->  
            </list>  
        </property>  
    </bean>

    <!-- 配置文件上传,如果没有使用文件上传可以不用配置,当然如果不配,那么配置文件中也不必引入上传组件包 -->  
    <bean id="multipartResolver"    
        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">    
        <!-- 默认编码 -->  
        <property name="defaultEncoding" value="UTF-8" />    
        <!-- 文件大小最大值 -->  
        <property name="maxUploadSize" value="10485760000" />    
        <!-- 内存中的
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值