Linux上Swagger文档如何生成-LINUX-PHP中文网

Linux上Swagger文档如何生成

月夜之吻

发布： 2025-02-25 12:08:01

原创

343人浏览过

linux上swagger文档如何生成

本文介绍如何在Linux系统上生成Swagger文档，主要针对基于Spring Boot的Java项目。其他语言（如Python或Node.js）的实现方法略有不同。

一、添加Swagger依赖 (Maven项目)

在pom.xml文件中添加以下依赖项，版本号请根据您的Spring Boot版本调整：

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

登录后复制

二、Swagger配置 (Spring Boot)

创建一个配置类，例如SwaggerConfig.java，并添加如下代码：

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.yourproject")) // 请替换为您的Controller包路径
                .paths(PathSelectors.any())
                .build();
    }
}

登录后复制

请将"com.example.yourproject"替换为您的项目中Controller所在的包路径。

三、启动项目并访问Swagger UI

启动Spring Boot应用后，通常可以通过http://localhost:8080/swagger-ui.html访问Swagger UI界面。

四、生成Swagger文档

在Swagger UI界面中，您可以：