SpringBoot集成Swagger

最新推荐文章于 2024-11-07 14:39:53 发布

一阵雄风

最新推荐文章于 2024-11-07 14:39:53 发布

阅读量169

点赞数

分类专栏： Spring Boot

本文链接：https://blog.youkuaiyun.com/A9541170/article/details/105103791

版权

Spring Boot 专栏收录该内容

7 篇文章

订阅专栏

本文详细介绍如何使用Swagger2为Spring Boot项目生成API文档。通过引入依赖、配置Swagger、创建控制器及实体类，实现接口文档的自动生成与在线测试。

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

swagger _ helloworld

1.导包

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

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.配置Swagger 基本配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

import javax.print.Doc;
import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {

    //配置了swagger的bean实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
        //设置接口信息
        .apiInfo(apiInfo())
        //配置分组
        .groupName("一阵雄风")
        //是否启用swagger
        .enable(flag)
        .select()
    	.apis(RequestHandlerSelectors.basePackage("top.yc9064.swagger.controller"))
    	//过滤  那个路径
        //.paths(PathSelectors.ant("/user/**"))  只扫描请求前面带了 /user/ 的 注解 的 接口
		.build();;
    }


    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact("张三", "https://yc9064.gitee.io/", "906478612@qq.com");
        return new ApiInfo(
                "张三的swaggerApi文档",
                "加油",
                "V1.0",
                "https://www.baidu.com",
                contact,
                "Apacher 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>()
        );
    }
}

controller

@RestController
public class Hellocontroller {


    @ApiOperation(" 接口的注释:这个接口会返回' hello swagger!' ")//默认为接口的方法名称  
    @GetMapping("/hello")
    public String hello(){
        return "Hello swagger!";
    }

    //只要返回值存在实体类  就会出现在model
    @PostMapping("/user")
    public User getUser(){
        return new User();
    }
}