ssm集成Swagger详细步骤操作

最新推荐文章于 2024-04-21 19:03:56 发布

原创最新推荐文章于 2024-04-21 19:03:56 发布 · 1.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

本文详细介绍了如何在SSM（Spring、SpringMVC、Mybatis）项目中集成Swagger，包括引入依赖、配置SwaggerConfig、修改spring-mvc.xml以及编写接口和测试运行，帮助开发者便捷地实现API文档的自动化。

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

ssm框架:spring、springmvc、mybatis

第一步：引用依赖

		<!--swagger -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.6.1</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.6.1</version>
		</dependency>

第二步：新建 SwaggerConfig.java 类

package com.xufengtech.ticket.util;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;

@Configuration //声明该类为配置类
@EnableSwagger2 //声明启动Swagger2
@EnableWebMvc //声明启动mvc
public class SwaggerConfig{
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(""))//扫描的包路径
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(" ticket API接口")//文档说明
                .version("1.1.0")//文档版本说明
                .build();
    }
}

第三步：在spring-mvc.xml 配置

	<!-- swagger -->
	<bean
		class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration"
		id="swagger2Config" />
	<mvc:resources location="classpath:/META-INF/resources/"
		mapping="swagger-ui.html" />
	<mvc:resources location="classpath:/META-INF/resources/webjars/"
		mapping="/webjars/**" />

</beans>

第三步：编写接口com.xufengtech.ticket.controller