Springboot（一）之集成Swagger简单教程_springboot swagger 菜鸟教程-CSDN博客

本文链接：https://blog.csdn.net/qq_45425621/article/details/104870196

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括添加依赖、配置Swagger、编写API数据及访问Swagger界面的方法。

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

1.添加相关依赖

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

2.在主配置文件中配置swagger

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;

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;

@SpringBootApplication
@ComponentScan("com.example.demo.handler")
@EnableSwagger2
public class TracyStudyApplication {

	public static void main(String[] args) {
		SpringApplication.run(TracyStudyApplication.class, args);
	}
	
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.handler")) //要扫描的包
                .paths(PathSelectors.any())
                .build();
//        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("API测试")
                //创建人
                .contact(new Contact("Tracy", "http://www.api.test/", ""))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3.在相关类中编写api数据

package com.example.demo.handler;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
@CrossOrigin
@RestController
@RequestMapping("vue")
@Api(description = "用户操作接口")
public class VueController {
	
	@ApiOperation(value = "跳转页面",notes = "跳转页面")
	@ApiImplicitParam(name = "name" ,value = "value",paramType="query",required = true, dataType = "String")
	@GetMapping("test")
	public String test(String name) {
		System.out.println(name);
		return "Hello,Axio";
	}
}