如何在Linux上部署Swagger UI

linux

小樊

2025-03-01 22:45:23

栏目: 智能运维

在Linux上部署Swagger UI可以通过多种方式实现，以下是两种常见的方法：

方法一：使用Docker部署

安装Docker：如果你还没有安装Docker，请先安装它。可以使用以下命令安装Docker：
```
sudo apt update
sudo apt install docker.io
```
拉取Swagger UI Docker镜像：使用以下命令拉取Swagger UI的Docker镜像：
```
docker pull swaggerapi/swagger-ui-express
```
运行Swagger UI容器：使用以下命令运行Swagger UI容器，并将你的API文档挂载到容器中。假设你的API文档位于/path/to/swagger.json：
```
docker run -p 8080:8080 -v /path/to/swagger.json:/usr/src/app/swagger.json swaggerapi/swagger-ui-express
```
访问Swagger UI：打开浏览器并访问http://localhost:8080，你应该能够看到Swagger UI界面。

方法二：手动部署

安装Node.js和npm：如果你还没有安装Node.js和npm，请先安装它们。可以使用以下命令安装：
```
sudo apt update
sudo apt install nodejs npm
```
创建项目目录：创建一个新的项目目录并进入该目录：
```
mkdir swagger-ui-project
cd swagger-ui-project
```
初始化npm项目：初始化一个新的npm项目：
```
npm init -y
```
安装Swagger UI Express：安装Swagger UI Express库：
```
npm install swagger-ui-express
```

创建服务器文件：创建一个名为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));

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

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

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

启动服务器：使用以下命令启动服务器：
```
node server.js
```
访问Swagger UI：打开浏览器并访问http://localhost:3000/api-docs，你应该能够看到Swagger UI界面。

这两种方法都可以帮助你在Linux上部署Swagger UI。选择哪种方法取决于你的具体需求和环境。

亿速云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>

如何在Linux上部署Swagger UI

方法一：使用Docker部署

方法二：手动部署

最新问答

相关标签