使用Swagger在Debian上构建RESTful API的步骤

在Debian上使用Swagger构建RESTful API的步骤如下：

1. 安装必要的软件包

首先，确保你的Debian系统是最新的，并且安装了必要的软件包。

sudo apt update
sudo apt upgrade
sudo apt install -y git maven openjdk-11-jdk

2. 创建Maven项目

使用Maven创建一个新的Java项目。你可以手动创建项目结构，或者使用Spring Initializr来生成项目。

手动创建项目结构

mkdir my-rest-api
cd my-rest-api
mkdir -p src/main/java/com/example/myrestapi
mkdir -p src/main/resources

使用Spring Initializr

访问 https://start.spring.io/ 并配置你的项目：

• Group: com.example
• Artifact: my-rest-api
• Dependencies: Spring Web, Spring Data JPA, H2 Database (或其他数据库), Lombok

点击 “Generate” 下载ZIP文件，然后解压到你的工作目录。

3. 添加Swagger依赖

编辑 pom.xml 文件，添加Swagger依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Boot Starter Data JPA -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

    <!-- H2 Database -->
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!-- Lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- Swagger -->
    <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>

4. 配置Swagger

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

package com.example.myrestapi.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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.myrestapi.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

5. 创建RESTful API控制器

创建一个简单的RESTful API控制器。

package com.example.myrestapi.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyRestController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

6. 运行应用程序

在项目根目录下运行以下命令来启动Spring Boot应用程序。

mvn spring-boot:run

7. 访问Swagger UI

打开浏览器并访问 http://localhost:8080/swagger-ui.html，你应该能够看到Swagger UI界面，其中列出了你的API端点。

8. 测试API

你可以使用Swagger UI来测试你的API端点。

通过以上步骤，你已经在Debian上使用Swagger成功构建了一个RESTful API。