Debian如何集成Swagger与Spring Boot

在Debian系统上集成Swagger与Spring Boot，可以按照以下步骤进行：

1. 创建Spring Boot项目

首先，你需要创建一个Spring Boot项目。你可以使用Spring Initializr（https://start.spring.io/）来生成项目结构。

使用Spring Initializr生成项目：

• 访问 Spring Initializr。
• 选择以下选项：
  • Project: Maven Project 或 Gradle Project（根据你的喜好）
  • Language: Java
  • Spring Boot: 选择最新的稳定版本
  • Project Metadata:
    • Group: com.example
    • Artifact: swagger-demo
    • Name: swagger-demo
    • Description: Demo project for Swagger with Spring Boot
    • Package name: com.example.swaggerdemo
  • Packaging: Jar
  • Java: 选择你使用的Java版本（例如11）
• 添加依赖：
  • Spring Web
  • Springfox Swagger2
  • Springfox Swagger UI
• 点击 “Generate” 下载项目压缩包。

2. 解压并导入项目

将下载的项目压缩包解压到你的工作目录，然后使用你喜欢的IDE（如IntelliJ IDEA、Eclipse）导入项目。

3. 配置Swagger

在Spring Boot项目中配置Swagger，你需要创建一个配置类来启用Swagger。

创建Swagger配置类：

在你的项目中创建一个新的Java类，例如 SwaggerConfig.java，并添加以下代码：

package com.example.swaggerdemo;

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.swaggerdemo"))
                .paths(PathSelectors.any())
                .build();
    }
}

4. 添加Swagger依赖

确保你的 pom.xml（如果你使用Maven）或 build.gradle（如果你使用Gradle）文件中包含了Swagger的依赖。

Maven依赖：

<dependencies>
    
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
    
    <dependency>
        <groupId>io.springfoxgroupId>
        <artifactId>springfox-swagger2artifactId>
        <version>2.9.2version>
    dependency>
    
    <dependency>
        <groupId>io.springfoxgroupId>
        <artifactId>springfox-swagger-uiartifactId>
        <version>2.9.2version>
    dependency>
dependencies>

Gradle依赖：

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

5. 启动项目

在IDE中运行你的Spring Boot应用程序，或者使用命令行启动：

./mvnw spring-boot:run

6. 访问Swagger UI

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

7. 添加API文档

在你的Spring Boot控制器类中添加Swagger注解，以便生成API文档。例如：

package com.example.swaggerdemo.controller;

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 = "示例API")
public class ExampleController {

    @GetMapping("/hello")
    @ApiOperation("示例API的问候接口")
    public String hello() {
        return "Hello, Swagger!";
    }
}

重新启动应用程序并刷新Swagger UI页面，你应该能够看到新添加的API文档。

通过以上步骤，你就可以在Debian系统上成功集成Swagger与Spring Boot，并生成API文档。

以上就是关于“Debian如何集成Swagger与Spring Boot”的相关介绍，筋斗云是国内较早的云主机应用的服务商，拥有10余年行业经验，提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩，主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复；电子化备案，提交快速，专业团队7×24小时服务支持！

简单好用、高性价比云服务器租用链接：https://www.jindouyun.cn/product/cvm