温馨提示×

Ubuntu Swagger API文档在哪查看

小樊
59
2025-07-19 10:36:52
栏目: 智能运维

在Ubuntu上查看Swagger API文档,您可以通过以下几种方法:

使用Docker安装Swagger UI

  1. 安装Docker:如果您还没有安装Docker,可以使用以下命令安装:
sudo apt update sudo apt install docker.io 
  1. 拉取Swagger UI Docker镜像:使用以下命令拉取Swagger UI的Docker镜像:
docker pull swaggerapi/swagger-ui-express 
  1. 运行Swagger UI容器:运行一个容器并映射端口(例如8080):
docker run -p 8080:8080 swaggerapi/swagger-ui-express 
  1. 访问Swagger UI:打开浏览器并访问 http://localhost:8080 ,您应该能看到Swagger UI界面。

使用Node.js和Express安装Swagger UI

  1. 安装Node.js和npm:如果您还没有安装Node.js和npm,可以使用以下命令安装:
sudo apt update sudo apt install nodejs npm 
  1. 创建一个新的Node.js项目:创建一个新的目录并进入该目录:
mkdir swagger-ui-project cd swagger-ui-project 
  1. 初始化npm项目
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: An array of users schema: type: array items: $ref: '#/definitions/User' definitions: User: type: object properties: id: type: integer name: type: string 
  1. 运行应用
node app.js 
  1. 访问Swagger UI:打开浏览器并访问 http://localhost:3000/api-docs ,您应该能看到Swagger UI界面。

希望这些信息能帮助您在Ubuntu上找到并访问Swagger API文档。

0