OpenAPI规范验证
OpenAPI 3.0最小必需结构
openapi: "3.0.3" # Required: version string
info: # Required
title: "My API" # Required
version: "1.0.0" # Required
paths: # Required (can be empty {})
/users:
get:
summary: "Get all users"
responses: # Required in every operation
"200":
description: "OK" # Required in every response
常见验证错误
| 错误 | 修复方法 |
|---|---|
| Missing 'openapi' field | 在顶层添加openapi: "3.0.3" |
| Missing 'info.version' | 在info对象中添加version字符串 |
| Missing 'responses' | 每个操作至少需要一个响应 |
| Missing 'description' in response | 为每个状态码添加description |
| Invalid HTTP method | 使用:get/post/put/patch/delete/head/options |