Debian系统中Swagger怎样使用 - 问答

在Debian系统中使用Swagger，通常是通过集成在Spring Boot项目中的方式。以下是详细步骤：

1. 创建Spring Boot项目

首先，你需要在Debian系统上创建一个新的Spring Boot项目。你可以使用Spring Initializr（https://start.spring.io/）来生成项目骨架，选择必要的依赖，例如springfox-swagger2和springfox-swagger-ui。

2. 添加Swagger依赖

在你的pom.xml文件中添加Swagger的依赖：

<dependencies>
    <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>
</dependencies>

3. 配置Swagger

创建一个配置类来启用Swagger：

import springfox.documentation.builders.PathSelectors;
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() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

4. 使用Swagger注解

在你的控制器中使用Swagger注解来描述API：

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

@RestController
@RequestMapping("/api")
@Api(tags = "Sample API")
public class SampleController {

    @GetMapping("/hello")
    @ApiOperation(value = "Say hello", notes = "This is a sample API to demonstrate Swagger usage")
    public String sayHello() {
        return "Hello, World!";
    }
}

5. 运行项目

在Debian系统上运行你的Spring Boot项目。你可以使用以下命令：

mvn spring-boot:run

6. 访问Swagger UI

启动项目后，你可以通过浏览器访问Swagger UI：

http://localhost:8080/swagger-ui.html

在这里，你可以看到你的API文档，包括请求和响应的示例。

7. 使用Springdoc（推荐）

对于Spring Boot 3.x项目，推荐使用springdoc-openapi库，它提供了更现代和灵活的方式来集成Swagger/OpenAPI。

添加Springdoc依赖

在你的pom.xml文件中添加springdoc-openapi-starter-webmvc-ui依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.1.0</version>
</dependency>

配置Springdoc

Springdoc会自动配置Swagger UI，你不需要额外的配置类。

通过以上步骤，你就可以在Debian系统中使用Swagger来文档化和测试你的RESTful API了。

0 赞

0 踩