温馨提示×

怎么学linux swagger快

小樊
46
2026-10-15 09:17:52
栏目: 智能运维

要快速学会在 Linux 上使用 Swagger(一般指 OpenAPI + Swagger UI / Swagger Editor / Swagger Codegen),可以按下面这条「最短路径」来学,少走弯路。


一、先搞清楚你“学 Swagger”的目的

不同目的,学法完全不同:

  1. 只是看接口文档(最常用)
    → 学 Swagger UI 怎么部署、怎么看
  2. 写 API 文档(OpenAPI 规范)
    → 学 YAML / JSON 写法
  3. 自动生成代码(前端/后端)
    → 学 Swagger Codegen / OpenAPI Generator
  4. 在 Linux 上集成到项目
    → 学 Spring Boot / Go / Node + Swagger

二、最快上手路线(推荐 1~2 天)

✅ 第 1 步:在 Linux 上跑一个 Swagger UI(最快看到效果)

# 用 Docker 最简单
docker run -p 8080:8080 swaggerapi/swagger-ui

浏览器访问:

http://localhost:8080

✅ 你能立刻看到 Swagger 长什么样


✅ 第 2 步:写一个最小 OpenAPI 文件(核心)

新建 swagger.yaml:

openapi: 3.0.0
info:
  title: Demo API
  version: 1.0.0
paths:
  /hello:
    get:
      summary: say hello
      responses:
        '200':
          description: OK

用 Swagger Editor:

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

访问 http://localhost:8081

✅ 这是 Swagger 的“灵魂”


✅ 第 3 步:结合你的语言(任选一个)

Java(Spring Boot)

@SpringBootApplication
@EnableSwagger2
public class App {}

访问:

/swagger-ui.html

Go

swag init

访问:

/swagger/index.html

Node.js

npm i swagger-ui-express

三、别死记,记住这 3 个重点

  1. Swagger = OpenAPI 规范 + 工具
  2. YAML 比 JSON 好写
  3. UI 只是“展示”,核心是 API 定义

四、最快学习资源(按重要性)

  • 官方示例(直接抄):
    https://swagger.io/docs/specification/basic-structure/
  • Swagger Editor(边写边看)
  • 你项目的现有 Swagger 文件(最好老师)

五、如果你愿意,我可以:

  • 按你的 语言/框架 给具体步骤
  • 帮你 写一个可直接跑的 Swagger 示例
  • 教你 怎么从代码自动生成 Swagger

你现在是 Linux + 哪种语言?

0 踩