如何在Linux上搭建Swagger在线编辑器

在Linux上搭建Swagger在线编辑器可以通过以下几种方法实现：

使用Docker容器部署

1. 安装Docker：

• 如果你还没有安装Docker，请先安装它。可以参考Docker官方文档进行安装。

2. 拉取Swagger Editor和Swagger UI镜像：

docker pull swaggerapi/swagger-editor:v4.6.0
docker pull swaggerapi/swagger-ui:v4.15.5

3. 运行Swagger Editor容器：

docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0

4. 运行Swagger UI容器：

docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5

5. 访问Swagger Editor和Swagger UI：

• Swagger Editor: http://localhost:38080
• Swagger UI: http://localhost:38081

手动安装

1. 安装Node.js和npm：

sudo apt update
sudo apt install -y nodejs npm

2. 下载并解压Swagger Editor和Swagger UI：

wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.50.0.tar.gz
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz
tar -xvf swagger-editor-3.50.0.tar.gz
tar -xvf swagger-ui-3.50.0.tar.gz

3. 配置环境变量：

export PATH=$PATH:/path/to/swagger-editor/bin:/path/to/swagger-ui/bin

4. 启动Swagger Editor和Swagger UI：

cd swagger-editor
npm install
http-server -p 8080

5. 访问Swagger Editor：

• 打开浏览器，访问 http://your_server_ip:8080 即可使用Swagger Editor。

使用Springdoc-OpenAPI

1. 添加依赖： 在你的Spring Boot项目的pom.xml文件中添加springdoc-openapi-starter-webmvc-ui依赖。

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

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