如何在Linux环境下配置Swagger UI - 问答

在Linux环境下配置Swagger UI，可以按照以下步骤进行：

1. 安装Node.js和npm

Swagger UI通常通过Node.js运行。首先，确保你的系统上已经安装了Node.js和npm。

sudo apt update
sudo apt install nodejs npm

你可以通过以下命令检查是否安装成功：

node -v
npm -v

2. 创建项目目录

mkdir swagger-ui-project
cd swagger-ui-project

3. 初始化npm项目

初始化一个新的npm项目：

npm init -y

4. 安装Swagger UI Express

使用npm安装Swagger UI Express：

npm install swagger-ui-express

5. 创建服务器文件

创建一个名为server.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));

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

6. 创建Swagger文档

创建一个名为swagger.yaml的文件，并添加你的API文档。例如：

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

7. 启动服务器

在终端中运行以下命令启动服务器：

node server.js

8. 访问Swagger UI

打开浏览器，访问http://localhost:3000/api-docs，你应该能够看到Swagger UI界面，并且可以测试你的API。

9. 配置Nginx（可选）

如果你希望通过Nginx反向代理访问Swagger UI，可以按照以下步骤进行配置：

安装Nginx

sudo apt install nginx

配置Nginx

编辑Nginx配置文件（通常位于/etc/nginx/sites-available/default）：

sudo nano /etc/nginx/sites-available/default

添加以下内容：

server {
    listen 80;
    server_name your_domain_or_ip;

    location /api-docs {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

保存并退出编辑器，然后重启Nginx：

sudo systemctl restart nginx

现在，你可以通过http://your_domain_or_ip/api-docs访问Swagger UI。

通过以上步骤，你就可以在Linux环境下成功配置Swagger UI。

0 赞

0 踩