如何在Linux上部署Swagger UI以展示API - 问答

在Linux上部署Swagger UI以展示API，可以按照以下步骤进行：

1. 安装Node.js和npm

首先，确保你的Linux系统上已经安装了Node.js和npm。如果没有安装，可以通过以下命令安装：

sudo apt update
sudo apt install nodejs npm

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

node -v
npm -v

2. 安装Swagger UI Express

Swagger UI Express是一个用于展示Swagger文档的Express中间件。你可以通过npm来安装它：

npm install swagger-ui-express

3. 创建一个简单的Express应用

mkdir swagger-ui-demo
cd swagger-ui-demo

然后，创建一个名为app.js的文件，并添加以下代码：

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 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 on port ${PORT}`);
});

4. 创建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

5. 启动应用

在终端中运行以下命令启动你的Express应用：

node app.js

6. 访问Swagger UI

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

7. 部署到生产环境

如果你希望将应用部署到生产环境，可以考虑使用PM2来管理Node.js应用。首先安装PM2：

sudo npm install pm2 -g

然后使用PM2启动你的应用：

pm2 start app.js --name swagger-ui-app

PM2会帮助你管理应用的运行状态，并在应用崩溃时自动重启。

通过以上步骤，你就可以在Linux上成功部署Swagger UI以展示你的API了。

0 赞

0 踩