如何在Debian上自定義Swagger

在Debian系統上自定義Swagger，通常指的是對Swagger UI進行定制，以便更好地適應你的API文檔需求。以下是一些基本步驟來幫助你在Debian上自定義Swagger：

1. 安裝Swagger UI

首先，你需要在Debian系統上安裝Swagger UI。你可以使用npm（Node.js的包管理器）來安裝Swagger UI。

sudo apt update
sudo apt install nodejs npm
sudo npm install -g swagger-ui-express

2. 創建一個簡單的Express應用

創建一個新的目錄來存放你的Swagger UI應用，并進入該目錄。

mkdir swagger-ui-custom
cd swagger-ui-custom

創建一個名為app.js的文件，并添加以下內容：

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

// Load Swagger document
const swaggerDocument = YAML.load('./swagger.yaml');

const app = express();

// Serve Swagger docs
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}`);
});

3. 創建Swagger文檔

在你的項目目錄中創建一個名為swagger.yaml的文件，并添加你的API文檔。例如：

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI customization
  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

4. 運行應用

在項目目錄中運行以下命令來啟動你的Express應用：

node app.js

現在，你可以訪問http://localhost:3000/api-docs來查看你的Swagger UI界面。

5. 自定義Swagger UI

你可以通過修改swagger.yaml文件來定制Swagger文檔。例如，你可以添加更多的路徑、參數、響應等。

此外，你還可以通過修改app.js文件來自定義Swagger UI的外觀和行為。例如，你可以更改主題、添加自定義CSS或JavaScript文件等。

更改主題

你可以通過在swaggerUi.setup(swaggerDocument)中傳遞一個配置對象來更改主題：

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
  deepLinking: true,
  presets: [
    swaggerUi.presets.apis,
    swaggerUi.presets.promises
  ],
  plugins: [
    swaggerUi.plugins.DownloadUrl
  ],
  layout: "StandaloneLayout"
}));

添加自定義CSS或JavaScript

你可以在項目目錄中創建一個名為custom.css的文件，并在其中添加自定義CSS樣式。然后在app.js文件中引用該文件：

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
  customCss: '/path/to/custom.css'
}));

同樣地，你可以創建一個名為custom.js的文件，并在其中添加自定義JavaScript代碼。然后在app.js文件中引用該文件：

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
  customJs: '/path/to/custom.js'
}));

通過這些步驟，你可以在Debian系統上自定義Swagger UI，以滿足你的特定需求。