温馨提示×

swagger UI在ubuntu上如何使用

小樊
62
2025-05-19 16:41:33
栏目: 智能运维

在Ubuntu上使用Swagger UI的步骤如下:

方法一:使用Docker

  1. 安装Docker
sudo apt update sudo apt install docker.io 
  1. 拉取Swagger UI Docker镜像
docker pull swaggerapi/swagger-ui-express 
  1. 运行Swagger UI容器
docker run -p 8080:8080 swaggerapi/swagger-ui-express 
  1. 访问Swagger UI

在浏览器中访问 http://localhost:8080,你应该能看到Swagger UI界面。

方法二:使用Node.js和Express

  1. 安装Node.js和npm
sudo apt update sudo apt install nodejs npm 
  1. 创建一个新的Node.js项目
mkdir swagger-ui-project cd swagger-ui-project npm init -y 
  1. 安装Swagger UI Express
npm install swagger-ui-express 
  1. 创建一个简单的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}`); }); 
  1. 创建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: A list of users content: application/json: schema: type: array items: $ref: '#/definitions/User' definitions: User: type: object properties: id: type: integer name: type: string required: - id - name 
  1. 运行应用
node app.js 
  1. 访问Swagger UI

在浏览器中访问 http://localhost:3000/api-docs,你应该能看到Swagger UI界面。

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

0