Spring Boot Swagger

最新推荐文章于 2025-06-09 14:01:32 发布

原创最新推荐文章于 2025-06-09 14:01:32 发布 · 133 阅读

0 ·

CC 4.0 BY-SA版权

java 专栏收录该内容

129 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括创建项目、引入依赖、实体类定义、Swagger配置、启动类编写及Controller实现。通过本教程，读者可以快速掌握使用Swagger2进行API文档生成的方法。

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

Spring Boot Swagger

1.创建maven项目

新建项目并引进jar包

		<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		
		 <!-- SpringBoot 拦截器 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>

		<!-- SpringBoot Web容器 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<!-- swagger 2 ui -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.7.0</version>
		</dependency>
		<!-- swagger 2 core -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>

	</dependencies>

2.创建实体：

public class Student {
	private String id;
	
	private String name;

	public Student(String id, String name) {
		this.id = id;
		this.name = name;
	}

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Override
	public String toString() {
		return "Student [id=" + id + ", name=" + name + "]";
	}
}

3.配置Swagger：

@Configuration
@EnableSwagger2
public class Swagger2Config {

	@Bean
	public Docket empApiDoc() {
		return new Docket(DocumentationType.SWAGGER_2).select()
				.apis(RequestHandlerSelectors.basePackage("com.example.demo")).build();
	}
}

4.编写Spring boot 启动类：

@SpringBootApplication
public class SwaggerApplication {

	public static void main(String[] args) {
		SpringApplication.run(SwaggerApplication.class, args);
	}
}

5.编写Controller：

@RestController
@RequestMapping("/student")
public class StudentController {

	@GetMapping("/getStudent")
	public Student getEmp() {

		Student stu = new Student();
		stu.setId(101);
		stu.setName("test");

		return stu;
	}
}