如何从OpenAPI yaml schema生成JSON输入
基于OpenAPI YAML Schema生成输入JSON的实用工具汇总
以下是不同使用场景下实测可用的工具,覆盖不同操作习惯的需求:
本地CLI工具(适合批量处理/集成进开发工作流)
- OpenAPI Generator:生态最完善的开源OpenAPI处理工具,除了生成SDK、文档外,原生支持生成符合Schema约束的请求样例,执行命令
openapi-generator generate -i <你的schema文件路径> -g json即可直接输出对应输入JSON,同时兼容OpenAPI 3.x和Swagger 2.0所有版本。 - swagger-cli:Swagger官方推出的轻量命令行工具,适合不想装重依赖的场景,先执行
swagger-cli validate <你的schema文件路径>校验Schema合法性,再执行swagger-cli toJson --sample <你的schema文件路径>就能生成对应输入样例。 - yq + jq组合:如果你习惯用Shell工具链,可以先用yq把YAML格式的Schema转成JSON格式,再用jq基于Schema规则自定义生成样例,适合对生成规则有特殊要求的场景。
本地GUI工具(适合单次手动操作)
- Swagger UI:本地部署后直接导入你的YAML Schema,点开对应接口的「Try it out」按钮,会自动生成默认请求JSON样例,修改参数后可直接复制使用。
- Postman:将OpenAPI Schema导入Postman集合后,打开对应请求的「Body」标签页,选择raw->JSON格式,Postman会自动生成符合约束的默认输入JSON,同时支持实时校验你修改后的内容是否符合Schema要求。
- VS Code插件:安装OpenAPI (Swagger) Editor插件后,打开你的YAML Schema文件,右键选择「Generate Sample Payload」即可直接生成对应接口的输入JSON,全程不用离开编辑器。
在线工具(无需安装软件的临时场景)
直接用浏览器端运行的在线Swagger编辑器即可,本地导入你的Schema文件后不需要上传到服务器,在对应接口页就能导出样例JSON,处理全程都在本地浏览器完成。
小提示:自动生成的JSON默认填充的都是示例值,你需要根据实际业务需求修改对应参数,修改后可以用JSON Schema校验工具核对是否符合原Schema约束,避免后续请求出现格式错误。
内容的提问来源于stack exchange,提问作者Peter
相关产品推荐
相关产品推荐

