Ubuntu服務器上Swagger如何工作

在Ubuntu服務器上使用Swagger通常涉及以下幾個步驟：

安裝Node.js和npm

首先，確保你的Ubuntu系統上已經安裝了Node.js和npm。如果沒有安裝，可以通過以下命令安裝：

sudo apt update
sudo apt install nodejs npm

驗證安裝：

node -v
npm -v

安裝Swagger UI和Express

使用npm安裝Swagger UI Express，它是一個Node.js模塊，可以將Swagger文檔轉換為交互式的API文檔界面。

npm install swagger-ui-express

創建一個簡單的Express服務器

創建一個新的JavaScript文件，例如 server.js，并添加以下代碼來創建一個基本的Express服務器：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');

// 讀取Swagger文檔
const swaggerDocument = YAML.load('./swagger.yaml');
const app = express();

// 將Swagger文檔傳遞給swagger-ui-express
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

// 啟動服務器
const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`Server is running at http://localhost:${port}`);
});

編寫Swagger定義

在項目目錄中創建一個名為 swagger.yaml 的文件，這個文件將包含你的API的Swagger規范。以下是一個簡單的例子：

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI on Ubuntu
  version: '1.0.0'
host: localhost:3000
basePath: /api
schemes:
  - http
paths:
  /users:
    get:
      summary: List all users
      responses:
        '200':
          description: An array of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
definitions:
  User:
    type: object
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
        required:
          - id
          - name

運行服務器

在終端中，導航到你的應用目錄并運行以下命令來啟動你的應用：

node server.js

現在，你可以在瀏覽器中訪問 http://localhost:3000/api-docs 來查看你的Swagger UI界面，并與你的API進行交互。

以上步驟提供了一個基本的Swagger UI服務器搭建過程。在實際應用中，你可能需要根據你的API的具體需求來調整Swagger文檔和其他服務器配置。此外，如果你想要自動生成Swagger文檔，你可能需要使用Swagger工具鏈中的其他工具，如Swagger Editor或SwaggerHub。