温馨提示×

Swagger如何在Linux中运行

小樊
47
2025-09-12 06:31:05
栏目: 智能运维

在Linux中运行Swagger主要有Docker容器部署手动安装两种方式,以下是具体步骤:

一、Docker容器部署(推荐)

  1. 安装Docker

    sudo apt update && sudo apt install -y docker.io
    sudo systemctl start docker && sudo systemctl enable docker
    
  2. 拉取Swagger镜像

    • Swagger Editor:
      docker pull swaggerapi/swagger-editor:v4.6.0
      
    • Swagger UI:
      docker pull swaggerapi/swagger-ui:v4.15.5
      
  3. 运行容器

    • Swagger Editor(映射端口8080):
      docker run -d -p 8080:8080 swaggerapi/swagger-editor:v4.6.0
      
    • Swagger UI(映射端口8081):
      docker run -d -p 8081:8080 swaggerapi/swagger-ui:v4.15.5
      
  4. 访问服务

    • Swagger Editor:http://localhost:8080
    • Swagger UI:http://localhost:8081

二、手动安装

1. 安装依赖

  • Node.js和npm
    sudo apt update && sudo apt install -y nodejs npm
    

2. 部署Swagger Editor

  • 方式1:直接运行

    npx swagger-editor-server
    

    访问:http://localhost:8080

  • 方式2:自定义配置

    mkdir /opt/swagger-editor && cd /opt/swagger-editor
    wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
    tar -xvf v3.16.1.tar.gz && rm v3.16.1.tar.gz
    npm install
    

    创建index.js

    const express = require('express');
    const app = express();
    app.use('/swagger-editor', express.static('swagger-editor-3.16.1'));
    app.listen(8080, () => console.log('Swagger Editor running on http://localhost:8080'));
    

    启动:node index.js

3. 部署Swagger UI

  • 方式1:直接运行

    npx swagger-ui-dist
    

    访问:http://localhost:3000

  • 方式2:集成到Web服务器

    mkdir /opt/swagger-ui && cd /opt/swagger-ui
    wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.16.1.tar.gz
    tar -xvf v3.16.1.tar.gz && rm v3.16.1.tar.gz
    npm install
    

    配置Nginx/Apache反向代理至/swagger-ui路径。

三、注意事项

  • 端口冲突:若端口被占用,可通过-p参数修改映射端口(如-p 8082:8080)。
  • 生产环境:建议使用Docker或Nginx反向代理,避免直接暴露端口。
  • 版本兼容:确保Swagger Editor和UI版本匹配(如v4.x系列)。

以上步骤参考自,可根据实际需求选择部署方式。

0