在 Linux 上安装 Swagger(OpenAPI) 通常取决于你的使用场景,常见有 三种方式。下面按从简单到完整来说明,并给出示例命令,你可以按需选择。
✅ 适合:查看 / 编写 / 测试 OpenAPI 文档
✅ 不需要后端、不需要编程
sudo apt update
sudo apt install docker.io -y
sudo systemctl start docker
sudo systemctl enable docker
docker run -d -p 8080:8080 swaggerapi/swagger-editor
浏览器打开:
http://localhost:8080
✅ 完成 ✅
wget https://github.com/swagger-api/swagger-editor/archive/refs/heads/master.zip
unzip master.zip
cd swagger-editor-master
npx http-server -p 8080
访问:
http://localhost:8080
✅ 适合:已有 OpenAPI 接口,需要可视化 UI
docker run -d -p 8081:8080 swaggerapi/swagger-ui
访问:
http://localhost:8081
wget https://github.com/swagger-api/swagger-ui/archive/refs/heads/master.zip
unzip master.zip
sudo cp -r swagger-ui-master/dist/* /var/www/html/swagger/
配置 Nginx:
server {
listen 80;
root /var/www/html/swagger;
index index.html;
}
sudo apt install default-jre -y
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.46/swagger-codegen-cli-3.0.46.jar
使用:
java -jar swagger-codegen-cli-3.0.46.jar --help
生成代码示例:
java -jar swagger-codegen-cli-3.0.46.jar generate \
-i api.yaml \
-l java \
-o ./out
sudo apt install nodejs npm -y
npm install -g swagger-cli
验证:
swagger --version
✅ 不需要单独安装 Swagger
只需加依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
访问:
http://localhost:8080/swagger-ui.html
| 需求 | 推荐方式 |
|---|---|
| 只想写/看 API | Swagger Editor(Docker) |
| 展示已有接口 | Swagger UI |
| 自动生成代码 | Swagger Codegen |
| Java 项目 | springdoc-openapi |
你可以告诉我:
我可以直接给你最合适的一套命令 ✅