温馨提示×

ubuntu上swagger怎么用

小樊
42
2026-10-21 11:11:10
栏目: 智能运维

在 Ubuntu 上使用 Swagger,通常有三种常见场景。下面按最常见 → 进阶给你说明,你可以按需选择。


一、最常见:在 Ubuntu 上运行 Swagger UI(查看/调试 API)

1️⃣ 安装依赖

sudo apt update
sudo apt install -y curl unzip

2️⃣ 下载 Swagger UI

cd /tmp
curl -L https://github.com/swagger-api/swagger-ui/archive/refs/heads/master.zip -o swagger-ui.zip
unzip swagger-ui.zip
sudo mv swagger-ui-master /opt/swagger-ui

3️⃣ 用 Python 启一个静态服务

cd /opt/swagger-ui/dist
python3 -m http.server 8080

浏览器访问:

http://localhost:8080

✅ 默认会加载示例 API
✅ 修改 index.html 里的 url 指向你的 swagger.json


二、连接你自己的 API(swagger.json / openapi.yaml)

编辑:

/opt/swagger-ui/dist/index.html

找到:

url: "https://petstore.swagger.io/v2/swagger.json",

改成:

url: "http://你的IP:端口/swagger.json",

三、在代码中自动生成 Swagger(推荐开发方式)

✅ Spring Boot(Java)

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.3.0</version>
</dependency>

访问:

http://localhost:8080/swagger-ui.html

✅ Node.js(Express)

npm install swagger-ui-express yamljs
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const swaggerDocument = YAML.load('./swagger.yaml');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

访问:

http://localhost:3000/api-docs

✅ Python(FastAPI,最省事)

pip install fastapi uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/items")
def read_items():
    return [{"name": "item"}]

启动:

uvicorn main:app --reload

访问:

http://localhost:8000/docs

四、Docker 方式(最干净)

docker run -p 8080:8080 swaggerapi/swagger-ui

五、常见用途总结

用途 推荐方式
看别人 API Swagger UI
自己写 API FastAPI / SpringDoc
联调测试 Swagger UI
团队文档 OpenAPI + CI

如果你愿意,可以告诉我:

  • 用的是什么语言(Java / Python / Node)
  • 是看 API 还是 写 API
  • 是否在 Docker 环境

我可以给你定制步骤 + 示例配置文件。

0 踩