Debian环境下Swagger与Spring Boot如何集成

在Debian环境下，将Swagger与Spring Boot集成可以帮助你更好地为你的API创建文档和测试接口。以下是详细的步骤指南：

1. 创建Spring Boot项目

首先，你需要一个Spring Boot项目。你可以使用Spring Initializr来快速创建一个。

1. 访问 Spring Initializr。
2. 配置你的项目：
   • 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 或 17
3. 添加依赖：
   • Spring Web
   • Springfox Swagger2
   • Springfox Swagger UI
4. 点击 “Generate” 下载项目压缩包。
5. 解压并导入到你的IDE中（例如 IntelliJ IDEA 或 Eclipse）。

2. 配置Swagger

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

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

    }

}
    

3. 创建一个简单的Controller

创建一个简单的Controller来测试Swagger。

package com.example.swaggerdemo.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 HelloController {


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

    }

}

4. 运行Spring Boot应用

在终端中运行你的Spring Boot应用。

./mvnw spring-boot:run

5. 访问Swagger UI

打开浏览器并访问以下URL：

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

你应该能够看到Swagger UI界面，其中列出了你的API端点，并且可以测试这些端点。

6. 配置Swagger UI（可选）

你可以进一步自定义Swagger UI，例如添加API信息、安全配置等。以下是一个示例配置：

@Bean
public Docket api() {
    
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))
            .paths(PathSelectors.any())
            .build();

}


private ApiInfo apiInfo() {
    
    return new ApiInfoBuilder()
            .title("Swagger Demo API")
            .description("API documentation for Swagger Demo")
            .version("1.0.0")
            .build();

}

7. 安全配置（可选）

如果你需要为Swagger UI添加安全配置，可以在你的Spring Security配置中添加相应的规则。

@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {


    @Override
    protected void configure(HttpSecurity http) throws Exception {
    
        http.authorizeRequests()
                .antMatchers("/swagger-ui.html", "/webjars/**", "/swagger-resources/**").permitAll()
                .anyRequest().authenticated()
                .and()
                .formLogin()
                .and()
                .httpBasic();

    }

}
    

通过以上步骤，你就可以在Debian环境下成功集成Swagger与Spring Boot，并使用Swagger UI来测试和文档化你的API。

声明：本文内容由网友自发贡献，本站不承担相应法律责任。对本内容有异议或投诉，请联系2913721942#qq.com核实处理，我们将尽快回复您，谢谢合作！