溫馨提示×

ubuntu下swagger如何使用

小樊
42
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
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女