📋 输入OpenAPI规范
粘贴OpenAPI/Swagger规范（JSON或YAML），或拖拽文件上传。
📂 拖拽JSON/YAML文件到此处
或点击下方按钮选择文件
📖 OpenAPI规范详解
什么是OpenAPI规范
OpenAPI规范（OAS，原名Swagger规范）是Linux基金会旗下的开放标准，用于描述RESTful API的接口定义。它使用JSON或YAML格式，定义了API的端点路径、HTTP方法、请求参数、请求体、响应格式、安全认证等完整信息，使API文档可被机器读取和自动处理。
OpenAPI 3.x vs Swagger 2.0
- 版本标识：OpenAPI 3.x使用
openapi: "3.x.x"，Swagger 2.0使用swagger: "2.0" - 请求体：OpenAPI 3.x用
requestBody，Swagger 2.0用parameters中的in: body - 组件复用：OpenAPI 3.x用
components，Swagger 2.0用definitions - 安全定义：OpenAPI 3.x用
components/securitySchemes，Swagger 2.0用securityDefinitions - 组合Schema：OpenAPI 3.x支持
oneOf/anyOf/allOf组合 - 回调与链接：OpenAPI 3.x新增
callbacks和links支持
核心结构
- openapi/swagger：规范版本号
- info：API元信息（标题、描述、版本等）
- servers/host+basePath：API服务地址
- paths：API端点路径和方法定义
- components/definitions：可复用的Schema组件
- security：全局安全要求
- tags：端点分组标签
应用场景
- API文档生成：从规范自动生成可交互的API文档
- 代码生成：自动生成客户端SDK和服务端桩代码
- API测试：基于规范自动生成测试用例
- API治理：统一管理微服务API接口定义
- 团队协作：API设计先行（Design-First）的开发流程
📖 常见问题
什么是OpenAPI规范?
OpenAPI规范（原名Swagger规范）是一种用于描述RESTful API的标准化格式。它使用JSON或YAML语法定义API的端点、请求参数、响应格式、认证方式等，使API文档可被机器读取和自动生成客户端代码。
OpenAPI 3.x和Swagger 2.0有什么区别?
OpenAPI 3.x是Swagger 2.0的升级版本，主要区别：1)使用openapi字段代替swagger字段；2)支持oneOf/anyOf/allOf组合schema；3)改进的安全定义用components/securitySchemes；4)支持callback和link；5)请求体用requestBody代替body参数。
如何验证OpenAPI规范文件是否正确?
本工具会自动检测并解析OpenAPI/Swagger规范文件，检查JSON/YAML语法是否正确，是否包含必要字段（openapi/swagger、info、paths），并高亮显示缺失或格式错误的部分。
支持哪些格式的OpenAPI文件?
支持JSON和YAML两种格式的OpenAPI规范文件。可以直接粘贴内容、拖拽文件上传或输入URL导入。支持OpenAPI 3.0.x、3.1.x和Swagger 2.0版本。
数据会上传到服务器吗?
不会。所有OpenAPI规范解析和展示都在浏览器本地完成，API规范内容不会发送到任何服务器，保障您的API设计安全。
如何使用此工具查看API端点?
将OpenAPI规范内容粘贴到输入框中，或拖拽文件上传，工具会自动解析并以树形结构展示所有API端点。点击每个端点可查看详细的请求参数、响应格式和示例数据。