温馨提示×

debian swagger怎么导出接口

小樊
56
2026-10-10 14:41:16
栏目: 智能运维

在 Debian 上“导出 Swagger 接口”通常是指把 Swagger / OpenAPI 文档 导出成 JSON 或 YAML 文件,或者生成 客户端/服务端代码。下面按常见场景给你说明。


一、从运行中的 Swagger 导出接口文档(最常见)

1️⃣ 直接访问 Swagger JSON 接口

大多数 Swagger 项目都会暴露:

http://IP:端口/v2/api-docs

或

http://IP:端口/v3/api-docs

在 Debian 上用 curl 导出:

curl http://localhost:8080/v2/api-docs -o swagger.json

或 YAML(如果支持):

curl http://localhost:8080/v2/api-docs.yaml -o swagger.yaml

✅ 适用于:

  • Spring Boot + Swagger
  • Java / Go / Node 项目

2️⃣ 从 Swagger UI 页面导出

如果你能打开:

http://IP:端口/swagger-ui.html

操作步骤:

  1. 打开页面
  2. 右上角或页面底部找 “Download JSON”
  3. 保存为 swagger.json

二、使用 swagger-cli / openapi-cli 导出(推荐)

安装(Debian)

sudo apt update
sudo apt install nodejs npm -y
sudo npm install -g @redocly/openapi-cli

校验并导出

openapi lint swagger.json

如果是远程地址:

openapi lint http://localhost:8080/v2/api-docs

三、使用 swagger-codegen 导出接口(生成代码)

安装

sudo apt install default-jre -y
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar

生成客户端(如 Java / Python / TS)

java -jar swagger-codegen-cli.jar generate \
  -i swagger.json \
  -l java \
  -o ./client

支持语言:

  • java
  • python
  • typescript-axios
  • go
  • csharp

四、Spring Boot 项目自动导出(开发时)

在 pom.xml 中加入:

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

访问:

/v2/api-docs

然后 curl 导出即可。


五、如果你说的是“在 Debian 服务器上部署 Swagger”

可告诉我:

  • 后端语言(Java / Go / Node / Python)
  • Swagger 版本(2.x / 3.x OpenAPI)
  • 想要的结果(JSON / 代码 / 文档网页)

我可以直接给你对应命令。

0 踩