OpenAPI 速查
共 23 条 OpenAPI（Swagger）规范，涵盖基础结构、操作定义、组件与复用、安全、工具。 支持搜索与分类筛选，点击即可复制。
基础结构
用 YAML/JSON 描述 REST API。
| 命令 | 说明 |
|---|---|
| 声明规范版本（也有 3.1） | |
| API 元信息 | |
| 服务地址列表 | |
| 接口路径与方法 | |
| 分组与文档信息 |
操作定义
参数与请求/响应。
| 命令 | 说明 |
|---|---|
| 查询参数 | |
| 路径参数 | |
| 请求体 | |
| 响应定义 | |
| 操作唯一 id（生成客户端用） |
组件与复用
schemas 与 $ref。
| 命令 | 说明 |
|---|---|
| 定义可复用模型 | |
| 引用模型 | |
| 复用参数 | |
| 复用响应 |
安全
鉴权方案声明。
| 命令 | 说明 |
|---|---|
| Bearer Token | |
| API Key | |
| OAuth2 | |
| 全局或按操作启用 |
工具
编辑、校验与生成。
| 命令 | 说明 |
|---|---|
| 在线编辑与实时预览 | |
| 规范校验（Redocly） | |
| Spectral 规则校验 | |
| 生成客户端 SDK | |
| 把规范渲染成文档页面 |
使用说明
OpenAPI 速查：基础结构、操作定义、组件与复用、安全、工具；支持搜索与分类筛选，点击即可复制。
- 按用途点分类：基础结构、操作定义、组件与复用、安全、工具。
- 点「命令」列复制片段到 openapi.yaml。
- 模型放进 components/schemas 并用 $ref 复用，接口更简洁。
- 用 lint 校验规范，再用 openapi-generator 生成客户端。
常见问题
- 为什么建议用 3.0/3.1 而不是 2.0？
- 3.x 支持 requestBody、components 复用与更完整的 schema，工具生态也以 3.x 为主。
- 怎么写才方便生成 SDK？
- 给每个操作加唯一 operationId，并为请求/响应模型建好 schemas，生成器才能产出稳定代码。
- 需要联网吗？
- 不需要，本地可用。
延伸阅读
相关工具
KONG
Kong 速查
service / route / plugin / decK 速查
VEL
Velero 速查
backup create / restore / schedule 速查
CM
cert-manager 速查
Issuer / Certificate / ACME / 注解速查
LNK
Linkerd 速查
linkerd check / inject / stat / TrafficSplit 速查
AM
Alertmanager 速查
route / receivers / silence / amtool 速查
JG
Jaeger 速查
all-in-one / 采样 / collector / trace 查询速查