Spring-Boot 在线Swagger

最新推荐文章于 2024-02-27 14:15:49 发布

原创最新推荐文章于 2024-02-27 14:15:49 发布 · 163 阅读

0 ·

CC 4.0 BY-SA版权

SpringBoot 专栏收录该内容

4 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括添加依赖、配置Swagger2以及自定义展示页面等内容，帮助读者快速上手。

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

1、添加依赖

      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>${swagger.version}</version>
      </dependency>
      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>${swagger.version}</version>
      </dependency>

2、在spring-boot启动Application中添加@EnableSwagger2注解

此方法采用默认的Swagger页面

也可自定义Swagger

在spring-boot启动的Application同级目录下新建Swagger2类

package com.springboot.controller;

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

@Configuration
@EnableSwagger2
public class Swagger2 {
    //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //为当前包路径
            .apis(RequestHandlerSelectors.basePackage("com.springboot.controller"))
            .paths(PathSelectors.any())
            .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            //页面标题
            .title("Spring Boot 测试使用 Swagger2 构建RESTful API")
            //创建人
            .contact(new Contact("曲乐欧", "https://gitee.com/QuLeOu/spring-boot", "1242829404@qq.com"))
            //版本号
            .version("1.0")
            //描述
            .description("API 描述")
            .build();
    }


}