(swagger java) Java使用Swagger接口框架方法详解使用 Swagger 的基本步骤：添加 Maven 依赖配置 Swagger 和使用注解# 全网首发(图文详解1)

(swagger java) Java使用Swagger接口框架方法详解

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。集成 Swagger 到 Java 项目中，通常会使用 Spring Boot 框架来快速开发 RESTful API。以下是使用 Swagger 的基本步骤和一个简单示例。

步骤 1：添加 Maven 依赖

在 pom.xml 文件中加入 Swagger 相关的依赖。

<!-- Swagger2 的Maven依赖 -->
<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

在你的 Spring Boot 应用中创建一个配置类，用来配置 Swagger。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        // 配置 Swagger 文档生成详细信息
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                // 指定扫描的包路径来定义指定要建立API文档的控制器类或方法
                .apis(RequestHandlerSelectors.basePackage("com.yourpackage"))
                .build();
    }
}

步骤 3：使用注解

在你的Controller中使用Swagger的注解来增强API文档的可读性和可用性。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@RestController
@Api(tags = "用户管理相关接口") // 标记整个类，说明该类的功能
public class UserController {

    @GetMapping("/users")
    @ApiOperation("获取用户列表接口") // 标记这个方法，说明该方法的功能
    public List<User> listUsers() {
        // 方法实现
        return new ArrayList<>();
    }
}