首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >如何在SpringDoc OpenAPI3中引用文件?

如何在SpringDoc OpenAPI3中引用文件?
EN

Stack Overflow用户
提问于 2020-03-17 09:07:10
回答 1查看 2.3K关注 0票数 7

我有Springboot项目,我想在这里记录我的API:

这里,Webservice的例子是:

代码语言:javascript
运行
复制
    @ApiResponses(
        value = {
                @ApiResponse(responseCode = "200", content =  @Content(
                        mediaType = "*/*",
                        schema = @Schema(implementation = Object.class),
                        examples = {
                                @ExampleObject(name = "boo",
                                summary = "example of boo",
                                ref = "#/swagger/Planner/semi_planif_200_response.json")
                        }

                ))
        }
)
@PostMapping(value = "/startSemiPlanification", produces = "application/json")
private ResponseEntity<Object> startSemiPlanner( @RequestBody PlanificationDto planificationData,
                                                @RequestParam(name = "groupByUserCode", required = false) Optional<Boolean> groupByUserCode,
                                            @RequestParam(name = "range", defaultValue = "18") Integer range

我的问题是Swagger无法解决这个引用,ref =,我甚至尝试过使用绝对路径,但它没有工作:

以下是文件路径:

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2020-03-19 22:45:17

引用不是在编译时解析的,而是在运行项目之后,swagger引擎将解析这些引用,因为它们是服务器中的静态资源:

代码语言:javascript
运行
复制
 $ref= resources/swagger/user.json 

如果我们在localhost中运行我们的实例,那么资源将从这个url:localhost:8080/resources/swagger/user.json中获取。

提示:确保spring资源处理程序将目标资源放置在指定位置!

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/60719210

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档