ubuntu

Ubuntu Swagger如何安装

小樊
38
2025-06-13 00:46:49
栏目: 智能运维

在Ubuntu上安装Swagger(通常指的是OpenAPI Generator或Swagger UI)可以通过以下几种方法来完成:

使用OpenAPI Generator安装Swagger

  1. 更新系统包列表
sudo apt update
  1. 安装必要的依赖
sudo apt install openjdk-11-jdk maven
  1. 下载OpenAPI Generator
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/5.2.1/openapi-generator-cli-5.2.1.jar
  1. 使jar文件可执行
chmod +x openapi-generator-cli-5.2.1.jar
  1. 使用OpenAPI Generator生成代码
java -jar openapi-generator-cli-5.2.1.jar generate -i /path/to/your/api-spec.yaml -g java -o /path/to/output/directory
  1. 集成Swagger UI
java -jar openapi-generator-cli-5.2.1.jar generate -i /path/to/your/api-spec.yaml -g swagger-ui -o /path/to/output/directory

使用npm安装Swagger UI

  1. 更新系统包列表
sudo apt update
  1. 安装Node.js和npm
sudo apt install nodejs npm
  1. 全局安装Swagger UI
sudo npm install -g swagger-ui-express
  1. 创建一个简单的Express应用并集成Swagger UI
mkdir swagger-ui-example
cd swagger-ui-example
npm init -y
npm install 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.yaml 的文件,并添加你的Swagger文档。

  1. 启动服务器
node server.js

现在,你可以在浏览器中访问 http://localhost:3000/api-docs 来查看Swagger UI。

使用Docker安装Swagger

  1. 安装Docker(如果尚未安装):
sudo apt update
sudo apt install docker.io
  1. 拉取Swagger UI镜像
docker pull swaggerapi/swagger-ui-express
  1. 运行Swagger UI容器
docker run -p 8080:8080 -e SWAGGER_JSON=/app/swagger.json -v $(pwd):/app swaggerapi/swagger-ui-express

确保你的 swagger.json 文件位于当前目录中。

  1. 访问Swagger UI: 打开浏览器并访问 http://localhost:8080

通过以上步骤,你应该能够在Ubuntu系统上成功安装并运行Swagger UI或Swagger Editor。选择适合你的方法进行操作即可。

0
看了该问题的人还看了