Varied Example Values from same Model (Java)
Hey, I have two (somewhat related) situations where I would love some input on how to best approach this. I am using the swagger-core java library and doing all of this with annotations to my code.
1) I am aiming for an API response which has an Outside wrapper with the status, and a result document with the key for the specific document you are fetching (example here: https://medium.com/@shazow/how-i-design-json-api-responses-71900f00f2db ).
One problem I have encountered here is that if I have 1 "ResultWrapper" model which has one "Result" model, it would (in examples and the model) always display all possible results. So what I have ended up doing is created A Wrapper and a Result model for each possible result (f.ex a UserWrapper and userResult) which just extend the Abstract result wrapper and adds the User specific fields:
2) In a similar vein, I have defined the "example" values over the relevant fields (so for examle inside the User result model). The problem I'm having here is that it always returns all the fields as example values. For example one request I have (which would still use the User model), only returns an ID and activation status, but because I just define the User model as the response, it uses the example values of that field.
The one way I can see to tackle this is to create extensions of the models with different example values, descriptions etc. But that then comes with the problem that the bottom "Models" section has a ton of duplicated models, because each User response would have its own model (this is already kind of happening where each result has 3 different models because of the nested nature.)
Any input on how to best approach this? I guess to summarise I want to use the same underlying models for a lot of different operations (POST and responses), but use different example values for the different requests, and I want to avoid bloating (specifically the Model section) with endless configurations of the same model.