如何在Linux上搭建Swagger在线文档平台

在Linux上搭建Swagger在线文档平台可以通过以下步骤实现：

使用Springdoc-OpenAPI

Springdoc是一个流行的库，用于在Spring Boot项目中自动生成Swagger文档。以下是使用Springdoc-OpenAPI的步骤：

1. 添加依赖：在pom.xml文件中添加Springdoc-OpenAPI的依赖。

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

2. 配置：Springdoc会自动扫描项目中的API并生成文档。如果需要自定义配置，可以创建一个配置类。

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@OpenAPIDefinition(info = @Info(title = "Your API Title", version = "1.0.0"))
public class OpenApiConfig {
    // 可以在这里添加更多的自定义配置
}

3. 部署：将你的Spring Boot应用打包成JAR或WAR文件，并部署到Linux服务器上。启动应用后，可以通过访问http://<your-server-ip>:8080/swagger-ui/index.html来查看Swagger文档。

使用Swagger UI和Springfox（适用于Spring Boot 2.x）

虽然Springfox的最新版本已经不再维护，但对于仍在使用Spring Boot 2.x的项目，以下是基于Springfox的步骤：

1. 添加依赖：在pom.xml文件中添加Springfox的依赖。

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

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

3. 部署：将你的Spring Boot应用打包成JAR或WAR文件，并部署到Linux服务器上。启动应用后，可以通过访问http://<your-server-ip>:8080/swagger-ui.html来查看Swagger文档。

使用Swagger Editor

Swagger Editor是一个在线编辑器，可以用于编辑和验证Swagger规范文件（YAML或JSON格式）。

1. 下载并安装Node.js和npm：

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

2. 下载并解压Swagger Editor：

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install

3. 启动Swagger Editor：

npm start

4. 访问Swagger Editor：打开浏览器，访问http://<your-server-ip>:9000。

注意事项

• 确保服务器上的防火墙允许访问Swagger UI和Editor的端口。
• 如果使用的是Spring Boot项目，确保API接口已经正确注解，以便Swagger能够识别并生成文档。
• 对于生产环境，建议使用HTTPS来加密数据传输。

以上步骤可以帮助你在Linux上成功搭建Swagger在线文档平台。根据你的具体需求和技术栈，选择合适的工具和方法进行部署。