温馨提示×

怎样学习linux swagger

小樊
37
2026-09-03 13:22:14
栏目: 智能运维

学习 Linux 下的 Swagger(通常指 OpenAPI 生态,如 Swagger UI、Swagger Editor、Swagger Codegen / OpenAPI Generator 等),可以按下面路线系统学习。


一、先搞清楚:Swagger 是什么

Swagger 是一套 REST API 描述、调试、文档化 的工具集,现在更规范的说法是 OpenAPI

常见组件:

  • Swagger Editor:写 API 描述文件(YAML/JSON)
  • Swagger UI:把 API 文档变成可交互页面
  • Swagger Codegen / OpenAPI Generator:根据 API 生成代码
  • Springdoc / swagger-core:Java 里自动生成 API

二、Linux 学习环境准备

1. 基础环境

# 常用工具
sudo apt update
sudo apt install -y curl wget git openjdk-17-jdk docker.io

2. 学习建议环境

  • Linux 发行版:Ubuntu / CentOS
  • 容器化:Docker(强烈推荐)
  • 编辑器:VS Code + 插件(Swagger/OpenAPI)

三、快速入门(推荐 Docker 方式)

1. 启动 Swagger UI

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

浏览器访问:

http://localhost:8080

2. 使用 Swagger Editor

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

四、学习 OpenAPI 文件(核心)

示例 swagger.yaml

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

学习重点:

  • paths
  • parameters
  • requestBody
  • responses
  • components / schemas

五、在项目中集成 Swagger(以 Java 为例)

Spring Boot + Springdoc

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

访问:

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

六、Linux 下常用命令工具

Swagger Codegen

java -jar swagger-codegen-cli.jar generate \
  -i swagger.yaml \
  -l java \
  -o ./out

OpenAPI Generator(更现代)

docker run openapitools/openapi-generator-cli generate \
  -i swagger.yaml -g python -o ./client

七、学习路线建议

  1. ✅ 理解 REST API
  2. ✅ 学会写 OpenAPI YAML
  3. ✅ 用 Swagger UI 看文档
  4. ✅ 在项目中自动生成 API
  5. ✅ 用 Codegen 生成客户端/服务端代码

八、推荐学习资源

  • 官网:https://swagger.io
  • OpenAPI 规范:https://spec.openapis.org
  • GitHub:swagger-api
  • 书籍:《API Design Patterns》

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

  • 你用的是 哪种语言(Java / Go / Python)
  • 写文档、调接口,还是自动生成代码

我可以给你更针对性的 Linux + Swagger 实战示例。

0