温馨提示×

ubuntu swagger怎么用

小樊
45
2026-10-15 15:49:59
栏目: 智能运维

在 Ubuntu 上使用 Swagger,通常有两种常见场景:

  1. Swagger UI:查看/调试已有 API
  2. Swagger 编辑器 / 代码生成:编写 OpenAPI 文档或生成代码

下面按常见用法一步步说明(以 Ubuntu 20.04 / 22.04 为例)。


一、用 Swagger UI 查看 API(最简单)

方式 1:直接用 Docker(推荐)

sudo apt update
sudo apt install docker.io -y
sudo systemctl enable --now docker

docker run -p 8080:8080 -e SWAGGER_JSON=/foo/swagger.json -v $PWD:/foo swaggerapi/swagger-ui

浏览器打开:

http://localhost:8080

把 swagger.json 放到当前目录即可。


方式 2:用 Node 本地运行

sudo apt install nodejs npm -y
npm install -g swagger-ui-cli

swagger-ui-cli serve swagger.json

二、使用 Swagger Editor(写 OpenAPI)

Docker 方式

docker run -p 8081:8080 swaggerapi/swagger-editor

访问:

http://localhost:8081

三、用 Swagger Codegen 生成代码(后端/前端)

安装 Java

sudo apt install default-jre -y

下载 Codegen

wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar

生成 Spring Boot 代码

java -jar swagger-codegen-cli-3.0.35.jar generate \
  -i swagger.yaml \
  -l spring \
  -o ./generated-api

支持语言:

  • spring
  • python
  • go
  • typescript-axios
  • nodejs-express-server

四、在 Spring Boot 项目里集成 Swagger(开发 API)

Maven 依赖

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

启动后访问:

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

五、常见文件格式

  • swagger.json(Swagger 2.0)
  • openapi.yaml(OpenAPI 3.0,推荐)

示例:

openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
paths:
  /users:
    get:
      summary: 获取用户列表
      responses:
        '200':
          description: OK

六、如果你告诉我:

  • 用的语言(Java / Python / Go)
  • 是写 API 还是看 API
  • 是否用 Docker

我可以给你 更精确的 Ubuntu 使用教程。

0 踩