Swagger丝袜哥

蓝影铁哥

于 2024-03-11 09:43:12 发布

阅读量946

点赞数 28

文章标签： java 数据库 android

本文链接：https://blog.csdn.net/qq_36858491/article/details/135222305

版权

传送门

SpringMVC的源码解析（精品）
Spring6的源码解析（精品）
SpringBoot3框架（精品）
MyBatis框架（精品）
MyBatis-Plus
SpringDataJPA
SpringCloudNetflix
SpringCloudAlibaba（精品）
Shiro
SpringSecurity
java的LOG日志框架
Activiti（敬请期待）
JDK8新特性
 JDK9新特性
 JDK10新特性
 JDK11新特性
 JDK12新特性
 JDK13新特性
 JDK14新特性
 JDK15新特性
 JDK16新特性
 JDK17新特性
 JDK18新特性
 JDK19新特性
 JDK20新特性
 JDK21新特性
 其他技术文章传送门入口

一、概念

Swagger是一个用于设计、构建和文档化 RESTful API 的开源框架。它使用简单的注释语法来定义API的接口和参数，并通过自动生成文档和客户端代码的方式来增加开发人员的效率。Swagger还提供了一个互动式的API探索界面，可以让用户方便地测试和调试API。通过使用Swagger，开发人员可以更容易地构建和维护高质量的API，并提供给其他开发人员使用。

Swagger 是一个用于设计、构建和文档化 API 的工具集。它包括一系列开源工具，可以帮助开发团队更轻松地设计、构建、文档化和消费 RESTful Web 服务。

主要组成部分包括：

Swagger Editor：一个基于浏览器的编辑器，可以让开发者编写 OpenAPI 规范（以前称为 Swagger 规范），这是一种用于描述 RESTful API 的标准格式。
Swagger UI：一个可以根据 OpenAPI 规范自动生成交互式 API 文档的工具。通过 Swagger UI，用户可以直观地查看 API 的功能、参数、响应等信息，并尝试调用 API。
Swagger Codegen：一个可以根据 OpenAPI 规范自动生成 API 客户端库、服务器代码、甚至 API 文档的工具。它支持多种编程语言和框架，可以帮助开发团队快速生成与 API 相关的代码。

使用 Swagger 可以带来以下好处：

API 设计一致性：通过定义统一的 OpenAPI 规范，团队成员可以更容易地共享和理解 API 的设计和实现。
自动生成文档：借助 Swagger UI，开发团队可以轻松生成交互式的 API 文档，使得 API 更易于理解和消费。
增强交互性：Swagger UI 提供了一个交互式界面，让用户可以直接在文档中测试 API，而不必依赖额外的工具或客户端。

总的来说，Swagger 是一个强大的工具集，可以帮助开发团队更高效地设计、构建和文档化 API，提升团队的协作效率和开发体验。
在这里插入图片描述

二、简单入门

在这里插入图片描述

三、注解

在这里插入图片描述

四、分组

配置类中多写几个Bean方法指定组就可以了
在这里插入图片描述

五、设置过滤

在这里插入图片描述

六、使用

Swagger是一种用于描述、构建、测试和使用RESTful风格的Web服务的工具和框架。它提供了一种简洁易用的方式来描述API，并可以生成可交互的API文档。

使用Swagger可以做到以下几个步骤：

添加Swagger依赖：在你的项目中添加Swagger的依赖库。如果使用Maven管理项目，可以在pom.xml文件中添加如下依赖：

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.10.5</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>`在这里插入代码片`
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.10.5</version>
</dependency>

创建Swagger配置类：创建一个配置类来启用Swagger并进行一些基本配置。例如，创建一个名为SwaggerConfig的类，添加注解@EnableSwagger2，开启Swagger支持：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    // 配置代码
}

配置Swagger文档信息：在SwaggerConfig类中，可以配置一些基本的Swagger文档信息，例如API标题、版本号、描述等。可以使用Swagger的注解来完成配置，例如：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.api"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API")
                .version("1.0")
                .build();
    }
}

添加API文档注解：在你的Controller类中，使用Swagger的注解来描述API接口的信息，例如接口的路径、请求方法、请求参数等。例如：

@RestController
@RequestMapping("/api")
@Api(tags = "User API")
public class UserController {
    @ApiOperation("Get user by ID")
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable Long id) {
        // 实现代码
    }
}

以上就是使用Swagger的基本步骤。启动项目后，可以访问http://localhost:8080/swagger-ui.html来查看生成的API文档并进行测试。

七、搭建springboot之后怎么集成swagger

要在Spring Boot项目中集成Swagger，可以按照以下步骤进行操作：

添加Swagger依赖：在项目的pom.xml文件中添加Swagger依赖。可以使用以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

创建Swagger配置类：创建一个配置类来配置Swagger。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}