如何阻止OpenAPIV3Parser在序列化时自动添加默认服务器URL '/'?
如何阻止OpenAPIV3Parser在序列化时自动添加默认服务器URL '/'?
我之前也碰到过这个糟心的问题——明明我的OpenAPI文档里压根没定义服务器,用OpenAPIV3Parser解析后却自动多出个URL为"/"的默认服务器,序列化后或者在Swagger UI里展示的时候,这个多余的基础路径看着特别碍眼。其实解决方法很简单,只要给解析器加个配置就行:
- 首先创建
ParserOptions实例,调用setAddDefaultServer(false),这个方法就是用来关闭自动添加默认服务器的功能的。 - 然后把这个配置传给解析器的
readContents方法,这样解析出来的OpenAPI对象就不会带那个默认的"/"服务器了。
给你个具体的代码示例参考:
// 初始化解析配置,禁用默认服务器自动添加 ParserOptions parserOptions = new ParserOptions(); parserOptions.setAddDefaultServer(false); // 使用带配置的解析器读取文档 OpenAPIV3Parser parser = new OpenAPIV3Parser(); OpenAPI openAPI = parser.readContents(yourOpenApiContent, null, parserOptions).getOpenAPI(); // 现在序列化或者传给Swagger UI时,就不会出现多余的"/"服务器了 String serializedDoc = Json.mapper().writeValueAsString(openAPI);
这个配置项是swagger-parser专门为这类场景设计的,只要你的库版本不是特别旧(比如2.x及以上版本都支持),用这个方法就能完美解决问题,保证解析后的文档和你原始定义的保持一致。
内容来源于stack exchange
相关产品推荐
相关产品推荐

