You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello,
I am currently writing my API swagger doc so for example on this route:
router.GET("/tl/:id", []fizz.OperationOption{
fizz.ID("get_by_id"),
fizz.Description("Get by its id."),
fizz.Response("200",
"Example of a successful call by id.<br>",
dedicated.TlResponse{}, nil, GetByIdSuccessExemple),
}, tonic.Handler(handler.GetById, http.StatusOK))
But if do that I get an error because examples for status 200 are already generated by tonic, so I've added example tags to my response struct:
but some fields of my struct are type interface{} because I can't know the exact type of object I'm getting from my API.
So if I use the example tag on an interface{} type, in my swaggers the example for this field says "string"
But it's not clear for someone who reads this and don't know the project, so I tried using the fizz.Response on another status and I can put some object example values in those interface{} fields...
I could use "default" status code but I think its still not clear in the swagger to have status 200 example with "string" for a field and under it, having an object for the same field :/
Is their a way to override the 200 status/default example ?
Thanks :)
The text was updated successfully, but these errors were encountered:
Hello,
I am currently writing my API swagger doc so for example on this route:
But if do that I get an error because examples for status 200 are already generated by tonic, so I've added example tags to my response struct:
but some fields of my struct are type
interface{}
because I can't know the exact type of object I'm getting from my API.So if I use the example tag on an
interface{}
type, in my swaggers the example for this field says "string"But it's not clear for someone who reads this and don't know the project, so I tried using the fizz.Response on another status and I can put some object example values in those
interface{}
fields...I could use "default" status code but I think its still not clear in the swagger to have status 200 example with "string" for a field and under it, having an object for the same field :/
Is their a way to override the 200 status/default example ?
Thanks :)
The text was updated successfully, but these errors were encountered: