Swagger 是一個用于設計、構建、記錄和使用 RESTful Web 服務的框架。它可以幫助開發者自動生成 API 文檔，并提供一個交互式的界面，使用戶能夠直接在瀏覽器中測試 API。在 Debian 系統上實現 Swagger 自動生成 API 文檔，通常需要以下幾個步驟：
安裝 Swagger 工具：
Debian 系統上可以通過包管理器安裝 Swagger 相關的工具，例如 swagger-ui-express，這是一個用于 Node.js 的 Swagger UI 實現。
sudo apt update
sudo apt install nodejs npm
sudo npm install -g swagger-ui-express
編寫 API 文檔：
使用 YAML 或 JSON 格式編寫 API 文檔。Swagger 提供了一個規范，你可以根據這個規范來描述你的 API。例如，創建一個名為 api.yaml 的文件：
swagger: '2.0'
info:
title: Sample API
description: A sample API to demonstrate Swagger
version: '1.0.0'
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
集成 Swagger 到你的應用：
在你的 Node.js 應用中集成 Swagger UI。首先，你需要安裝 swagger-ui-express 和 swagger-jsdoc（用于解析 Swagger 文檔）：
npm install swagger-ui-express swagger-jsdoc
然后，在你的應用中使用這些工具：
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./api.yaml');
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Server is running on port ${PORT}`);
});
運行你的應用：
運行你的 Node.js 應用，然后訪問 http://localhost:3000/api-docs，你應該能夠看到 Swagger 自動生成的 API 文檔，并且可以進行交互式測試。
請注意，這里的步驟是針對使用 Node.js 和 Express 的情況。如果你使用的是其他編程語言或框架，步驟可能會有所不同。此外，Swagger 的版本也可能影響具體的實現細節，上述步驟基于 Swagger 2.0 版本。如果你使用的是 OpenAPI 3.0 或更高版本，可能需要使用不同的工具和配置。
