Swagger Core 2.x OpeanAPI 3 Examples tied to Dataclass(variables)

Question

I'd like to to add examples to my OpenAPI 3 Autogenerated Documentation which I generate with "io.swagger.core.v3.swagger-gradle-plugin"

I didn't find a way to bind the example to the variable of my dataclass, like you could do with @ApiModelProperty for a swagger V2 file.

All I found is @ExampleObject which you have to define for each response as a String. Am I missing something or is that the only way to add Examples to a swagger.v3 approach?

mariore · Answer

I found it out myself, you need the @Schema annotation and not the @Parameter annotation, moreover it ignores the variables and only uses the Getter and Setter to generate the YAML.

Forum Discussion

Swagger Core 2.x OpeanAPI 3 Examples tied to Dataclass(variables)

Related Content

Gmail OAuth 2.0 API Automation Example and example SubmitListener.beforeSubmit

$ref in response example relative to response example

Multipart/form-data request body example

Examples for enum Choices

Auto-swapping examples

Recent Discussions

Bootstrapped servlet returns empty JSON as of 2.2.24

Python 3.6 client support

I want to add variable in swagger like postman

Endpoint Expansion

Mixed-Type Arrays with java swagger-annotations 2.0.3.