Ubuntu上Swagger API文档怎样生成

在Ubuntu上为Spring Boot应用程序配置Swagger并生成API文档，可以按照以下步骤进行：

1. 添加Swagger依赖

在你的Spring Boot项目的 pom.xml 文件中添加Swagger相关的依赖。例如：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <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>
</dependencies>

2. 配置Swagger

创建一个Java类来配置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.basePackage("com.yourpackage")) // 替换为你的控制器包路径
                .paths(PathSelectors.any())
                .build();
    }
}

3. 启动Spring Boot应用程序

在终端中运行以下命令来启动Spring Boot应用：

./mvnw spring-boot:run

4. 访问Swagger UI

启动应用程序后，你可以通过浏览器访问Swagger UI界面。默认情况下，你可以通过以下URL访问：

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

这里假设你的应用程序运行在8080端口上。

5. 生成Swagger文档

在Swagger UI界面中，你可以：

• 点击“Authorize”（如有需要）进行授权。
• 点击“Download Swagger JSON”下载JSON格式的API文档。
• 点击“Download Swagger YAML”下载YAML格式的API文档。

6. 使用Swagger Editor（可选）

Swagger Editor是一个可视化编辑器，方便编写和管理OpenAPI规范。你可以使用Docker部署并通过内网穿透工具远程访问。

通过以上步骤，你可以在Ubuntu上成功配置Swagger并生成API文档。如果有任何问题，请检查你的依赖版本是否兼容，并确保你的Spring Boot应用程序正确运行。