ubuntu

swagger在ubuntu上的部署流程是什么

小樊
33
2025-08-25 10:39:31
栏目: 智能运维

Swagger在Ubuntu上的部署流程可根据使用场景选择以下方式:

一、Docker部署(推荐)

  1. 安装Docker

    sudo apt update
    sudo apt install docker.io
    sudo systemctl start docker
    sudo systemctl enable docker
    
  2. 创建Dockerfile
    在项目根目录新建Dockerfile,内容如下:

    FROM node:14
    WORKDIR /app
    COPY . .
    RUN npm install
    EXPOSE 3000
    CMD ["npm", "start"]
    
  3. 构建并运行容器

    docker build -t swagger-ui .
    docker run -d -p 3000:3000 --name swagger-container swagger-ui
    
  4. 访问Swagger UI
    浏览器输入http://localhost:3000即可查看。

二、Node.js环境部署

  1. 安装依赖

    sudo apt install nodejs npm
    npm install -g swagger-ui-express swagger-jsdoc
    
  2. 配置项目

    • 创建swagger.jsonswagger.yaml定义API文档。
    • 在Express应用中集成Swagger:
      const express = require('express');
      const swaggerUi = require('swagger-ui-express');
      const swaggerDocument = require('./swagger.json');
      const app = express();
      app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
      app.listen(3000, () => console.log('Server running on port 3000'));
      
  3. 启动服务

    node app.js
    

    访问http://localhost:3000/api-docs查看文档。

三、可选:Nginx反向代理(适用于生产环境)

  1. 安装Nginx

    sudo apt install nginx
    
  2. 配置代理
    编辑/etc/nginx/sites-available/default,添加:

    location /swagger/ {
        proxy_pass http://localhost:3000/;
        proxy_set_header Host $host;
    }
    
  3. 重启Nginx

    sudo systemctl restart nginx
    

    之后可通过http://your-server-ip/swagger/访问。

注意事项

根据实际需求选择部署方式,Docker适合快速部署,Node.js适合集成到现有后端服务。

0
看了该问题的人还看了