ubuntu

ubuntu下swagger如何使用

小樊
34
2025-08-07 04:53:38
栏目: 智能运维

在Ubuntu下使用Swagger主要有以下两种常见方式:

基于Node.js环境(推荐)

  1. 安装依赖:确保已安装Node.js和npm,然后安装Swagger工具:
    sudo apt update
    sudo apt install nodejs npm
    sudo npm install -g swagger-ui-express
    
  2. 配置Swagger:创建swagger.jsonswagger.yaml文件,定义API元数据,如路径、参数等。
  3. 集成到应用:若用Express框架,在应用代码中添加:
    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));
    const port = 3000;
    app.listen(port, () => {
        console.log(`Server is running on port ${port}`);
    });
    
  4. 运行应用:执行node index.js(假设文件名为index.js),然后访问http://localhost:3000/api-docs查看Swagger UI。

使用Docker

  1. 安装Docker
    sudo apt update
    sudo apt install docker.io
    
  2. 拉取镜像
    docker pull swaggerapi/swagger-ui-express
    
  3. 运行容器
    docker run -p 8080:8080 -v $(pwd):/app swaggerapi/swagger-ui-express
    
  4. 访问Swagger UI:打开浏览器访问http://localhost:8080

0
看了该问题的人还看了