如何在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，以满足你的特定需求。