Ubuntu如何集成Swagger UI

ubuntu

小樊

2025-03-04 04:25:30

栏目: 智能运维

在Ubuntu上集成Swagger UI，可以按照以下步骤进行：

方法一：使用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容器：运行一个容器并映射端口（例如8080）：
```
docker run -p 8080:8080 swaggerapi/swagger-ui-express
```
访问Swagger UI：打开浏览器并访问 http://localhost:8080，你应该能看到Swagger UI界面。

方法二：使用Node.js和Express

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

创建一个简单的Express应用：创建一个名为 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 on port ${PORT}`);
});

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

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI integration
  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 app.js
```
访问Swagger UI：打开浏览器并访问 http://localhost:3000/api-docs，你应该能看到Swagger UI界面。

通过以上两种方法，你可以在Ubuntu上集成Swagger UI，并查看和测试你的API文档。

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

Ubuntu如何集成Swagger UI

方法一：使用Docker

方法二：使用Node.js和Express

最新问答

相关标签