OpenAPI YAML
直接回答
OpenAPI 配置通常以 YAML 表达。保持缩进一致,应用/部署前校验,并结合生态专用 dry-run 与通用语法检查。
典型片段
openapi: 3.0.3
info:
title: Sample API
version: 1.0.0
paths:
/health:
get:
responses:
'200':
description: ok校验建议
OpenAPI documents are YAML or JSON; convert carefully and keep indentation valid.
相关
此类文件常见坑
- 嵌套键下缩进错误。
- 未加引号的值被解析成布尔。
- 从网页复制带入 Tab。
先用 YAML.cc 查语法,再用生态原生检查。
YAML 与 JSON 等价
OpenAPI 可用 YAML 或 JSON 表达同一文档。从 JSON 转 YAML 后务必检查缩进与多行描述字段(|)。
引用与组件
$ref 路径写错时,YAML 语法仍可能通过。需要 OpenAPI 专用校验器做第二道检查;语法层可用 YAML.cc。