在 Linux 下安装 Swagger,通常取决于你用的是 Swagger UI、Swagger Editor 还是 Swagger Codegen / OpenAPI Generator。下面按常见场景分别说明。
Swagger UI 用来可视化展示 OpenAPI 文档。
# 下载最新版本
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v5.17.14.zip
# 解压
unzip v5.17.14.zip
cd swagger-ui-5.17.14/dist
然后启动一个 HTTP 服务:
python3 -m http.server 8080
浏览器访问:
http://localhost:8080
✅ 适合本地查看 API 文档
docker run -p 8080:8080 \
-e SWAGGER_JSON=/app/swagger.json \
-v $(pwd):/app \
swaggerapi/swagger-ui
访问:
http://localhost:8080
docker run -d -p 8081:8080 swaggerapi/swagger-editor
访问:
http://localhost:8081
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v4.16.0.zip
unzip v4.16.0.zip
cd swagger-editor-4.16.0
npx http-server -p 8081
⚠️ Swagger Codegen 已逐渐被 OpenAPI Generator 取代,但仍在用。
docker run --rm \
-v $(pwd):/local \
swaggerapi/swagger-codegen-cli \
generate \
-i /local/swagger.json \
-l java \
-o /local/out
wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.32/swagger-codegen-cli-2.4.32.jar
java -jar swagger-codegen-cli-2.4.32.jar --help
如果你是新项目,强烈推荐。
docker run --rm \
-v $(pwd):/local \
openapitools/openapi-generator-cli generate \
-i /local/openapi.yaml \
-g spring \
-o /local/output
或安装 CLI:
npm install @openapitools/openapi-generator-cli -g
确保你有:
# Java(Codegen)
java -version
# Docker
docker --version
# Node.js(可选)
node -v
| 需求 | 推荐 |
|---|---|
| 查看 API 文档 | Swagger UI |
| 编写 OpenAPI | Swagger Editor |
| 生成前后端代码 | OpenAPI Generator |
| 最简单 | Docker |
如果你愿意,可以告诉我:
我可以给你 更精确的配置示例 ✅