Linux中Swagger文档如何生成 - 问答

在Linux系统中生成Swagger文档通常涉及以下几个步骤：

1. 安装Swagger

首先，确保你的Linux系统中已经安装了Swagger。如果你使用的是Spring Boot项目，Swagger通常已经包含在其中。对于其他类型的Java项目，你需要添加Swagger依赖。例如，在Maven项目的pom.xml文件中添加以下依赖：

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

2. 配置Swagger

在项目中配置Swagger。创建一个Swagger配置类，例如SwaggerConfig.java，并添加以下代码：

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

这段代码会启用Swagger2并允许所有请求和路径。

3. 启动应用程序

启动你的应用程序。确保Swagger UI已经成功启动并可以在浏览器中访问。通常，你可以通过访问http://localhost:8080/swagger-ui.html来查看Swagger UI。

4. 生成并导出Swagger文档

在Swagger UI页面中，点击“Authorize”按钮，然后点击“Download Swagger JSON”按钮。这将下载一个包含所有API信息的JSON文件。你也可以选择导出为YAML格式，只需点击“Download Swagger YAML”按钮即可。

5. 使用Springdoc生成Swagger文档（推荐）

对于Spring Boot 2.4及以上版本，推荐使用springdoc-openapi-starter-webmvc-ui库来集成Swagger 3.x。首先，在pom.xml中添加以下依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.1.0</version>
</dependency>

然后，在Spring Boot应用程序的主类上添加@EnableOpenApi注解：

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableOpenApi;

@SpringBootApplication
@EnableOpenApi
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

这样，你就可以使用http://localhost:8080/swagger-ui/访问自动生成的Swagger文档了。

通过以上步骤，你可以在Linux系统中成功生成并导出Swagger文档。

0 赞

0 踩