Debian服务器Swagger API部署最佳实践

发布时间:2025-04-30 00:48:03

阅读量:83

在Debian服务器上部署Swagger API时，可以遵循以下最佳实践：

环境准备

更新包列表：
```
sudo apt update
```

安装Java和Maven：

sudo apt install openjdk-11-jdk
sudo apt install maven

验证安装：
```
java -version
mvn -version
```

创建Spring Boot项目

使用 Spring Initializr 创建一个新的Spring Boot项目，选择必要的依赖，例如 springfox-boot-starter。

引入Swagger依赖

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

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

配置Swagger

在 application.yml 或 application.properties 文件中配置Swagger：

application.yml:

springfox:
  documentation:
    swagger-ui:
      enabled: true

application.properties:

springfox.documentation.swagger-ui.enabled=true

启动项目

使用以下命令启动Spring Boot项目：
```
mvn spring-boot:run
```

访问Swagger UI

项目启动后，打开浏览器，访问以下URL来查看Swagger生成的API文档：
```
http://localhost:8080/swagger-ui/
```

编写API接口并使用Swagger注解

在控制器类中使用Swagger注解来描述API接口：

import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;

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

    @GetMapping("/hello")
    @ApiOperation(value = "Say hello", response = String.class)
    public String sayHello() {
        return "Hello, World!";
    }

    @PostMapping("/data")
    @ApiOperation(value = "Send data", requestBody = @io.swagger.annotations.ApiRequestBody(content = @io.swagger.annotations.ApiContent(schema = @io.swagger.annotations.ApiSchema(implementation = String.class))), response = String.class)
    public String sendData(@RequestBody String data) {
        return "Received: " + data;
    }
}