Maven+SpringMVC+Swagger 整合完整流程

本文详细介绍了如何将Swagger与Maven和SpringMVC进行整合,以自动生成RESTful API文档。首先解释了Swagger的作用和背景,接着添加了必要的依赖,创建了Swagger配置类,并指导如何配置web.xml和springmvc.xml。最后,修改swagger-ui的URL并展示如何访问生成的接口文档。

    都说swagger是一个非常牛的自动生成接口文档的应用框架

一、Swagger是什么?

   官方介绍:  Swagger是一个规范且完整的框架,提供描述、生产、消费和可视化RESTful Web Service。

   专业角度:Swagger是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。

二、导入swagger需要的依赖

 在 POM.xml 中粘贴如下依赖:

<!-- swagger API -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.6.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.6.0</version>
		</dependency>
		<!-- swagger-springmvc dependencies -->
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-core</artifactId>
			<version>2.7.5</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-annotations</artifactId>
			<version>2.7.5</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId&
<think>好的,用户想了解如何创建一个包含Spring、SpringMVC、MyBatis-Plus和Maven的项目。我需要根据之前的引用内容来整理步骤。首先,用户提到使用Maven创建项目,所以第一步应该是用Maven生成项目结构。引用1中提到在IDEA中通过File->New Project->Maven来创建Maven项目,这应该是第一步。接下来,需要配置pom.xml文件,添加相关的依赖。根据引用2、3、4,SpringBoot整合了这些框架,所以可能需要SpringBootStarter依赖。但用户的问题可能更偏向传统的Spring MVC项目,而不是SpringBoot。不过引用3中提到了在Spring项目中整合MyBatis-Plus,需要替换SqlSessionFactoryBean为MybatisSqlSessionFactoryBean,并配置数据源和映射文件路径。这可能涉及到Spring的XML配置。然后,用户需要定义启动类,如引用2中的LhWebApp类,使用@SpringBootApplication和@MapperScan注解。不过如果用户不使用Spring Boot,可能需要传统的web.xml配置和DispatcherServlet。但根据引用4,用户可能更倾向于使用Spring Boot来简化配置,所以可能需要结合这两种情况。另外,引用4中还提到了整合Swagger2,但用户的问题中没有提到这个,所以可能不需要包括这部分。但需要确保MyBatis-Plus的依赖正确添加到pom.xml中,比如mybatis-plus-boot-starter和mybatis-plus-extension。 还需要配置数据源,可能是在application.properties或application.yml中设置数据库连接信息。同时,根据引用3,配置MyBatis-Plus的SqlSessionFactoryBean,设置dataSource和mapperLocations。可能还需要创建实体类、Mapper接口以及对应的XML映射文件,或者使用MyBatis-Plus的注解方式。引用2中的@MapperScan注解用于扫描Mapper接口,确保它们被正确注册。最后,需要创建一个启动类,如果是Spring Boot的话,使用main方法启动。如果是传统的Spring MVC项目,可能需要部署到Tomcat服务器。但根据引用2和4,用户可能更倾向于使用Spring Boot来简化部署,所以步骤可能更偏向于Spring Boot项目。总结步骤应该是:创建Maven项目,添加依赖,配置数据源和MyBatis-Plus,编写实体和Mapper,创建启动类,配置SpringMVC,最后测试运行。需要确保每一步都正确引用之前的示例,比如依赖的版本号和配置项。</think>创建包含Spring、SpringMVC、MyBatis-Plus和Maven的项目的步骤如下: --- ### **一、创建Maven项目** 1. 在IDEA中选择`File -> New Project -> Maven` 2. 勾选`Create from archetype`,选择`maven-archetype-webapp`生成Web项目结构 3. 输入`GroupId`(如`com.example`)和`ArtifactId`(如`demo`)[^1] --- ### **二、配置pom.xml** 添加以下依赖: ```xml <!-- Spring核心 --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.3.20</version> </dependency> <!-- SpringMVC --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.3.20</version> </dependency> <!-- MyBatis-Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus</artifactId> <version>3.5.3.1</version> </dependency> <!-- 数据库连接池 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.30</version> </dependency> <!-- Servlet API --> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.1</version> <scope>provided</scope> </dependency> ``` --- ### **三、配置Spring和MyBatis-Plus** 1. **数据源配置**(`resources/db.properties`): ```properties jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/db_name?useSSL=false&serverTimezone=UTC jdbc.username=root jdbc.password=123456 ``` 2. **Spring配置文件**(`resources/applicationContext.xml`): ```xml <!-- 配置数据源 --> <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <property name="driverClassName" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </bean> <!-- 配置MyBatis-Plus的SqlSessionFactory --> <bean class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="mapperLocations" value="classpath*:mapper/*.xml"/> </bean> ``` --- ### **四、编写代码结构** 1. **实体类**(`src/main/java/com/example/entity/User.java`): ```java @TableName("user") public class User { @TableId(type = IdType.AUTO) private Long id; private String name; // getter/setter省略 } ``` 2. **Mapper接口**(`src/main/java/com/example/mapper/UserMapper.java`): ```java public interface UserMapper extends BaseMapper<User> {} ``` --- ### **五、配置SpringMVC** 1. **Web.xml配置**: ```xml <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:applicationContext.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> ``` --- ### **六、启动项目** 1. 配置Tomcat服务器并部署项目 2. 访问`http://localhost:8080`验证是否成功 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值