Springdoc-openapi external json file with relative path for example request body

Viewed 695

I am looking for a way to use a relative path for external JSON files while defining the example request body.

My current definition is like this:

@Operation(requestBody = @RequestBody(description = "Request", content = @Content(schema = @Schema(implementation = Request.class), examples = {
            @ExampleObject(
                    name = "An example request",
                    value = "{\n" +
                               "\"token\":\"token\"\n" +
                            "}",
                    summary = "Request"
            )}
)),summary = "summ", description = "desc")

I want to keep JSON value on an external JSON file.

I know that "externalValue" field can be used instead of "value" to reference an external json file, but it requires a URL. I want to keep it in the project file and use the relative path. I am using Open API v3.

For those who are just looking for external JSON file usage, you can use external JSON file from a URL like this:

@Operation(requestBody = @RequestBody(description = "Request", content = @Content(schema = @Schema(implementation = Request.class), examples = {
        @ExampleObject(
                name = "An example request",
                externalValue = "http://domain/test/example.json",
                summary = "Request"
        )}
)),summary = "summ", description = "desc")
0 Answers
Related