@io.swagger.annotations.ApiResponse reference element

258 views
Skip to first unread message

Ilia Baskine

unread,
Jan 15, 2016, 11:22:59 AM1/15/16
to Swagger
Can someone please explain to me how to user the reference element in ApiResponse annotation. Reference to what? What is the proper syntax of its value? 

Ilia Baskine

unread,
Jan 15, 2016, 11:36:11 AM1/15/16
to Swagger
Allow me to clarify my question. I believe that the reference value shall be in form "file-path/#/json-path". Is it true? If this is true then where shall I put the definition file in order for Swagger UI to pick it up?

tony tam

unread,
Jan 15, 2016, 12:11:21 PM1/15/16
to swagger-sw...@googlegroups.com
It’s not really clear what you’re asking.  I suggest you either check out the documentation at http://swagger.io or the samples at https://github.com/swagger-api/swagger-samples as there are many examples of how to use the annotations there.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Ilia Baskine

unread,
Jan 15, 2016, 1:40:45 PM1/15/16
to Swagger
Unfortunately documentation on this element is pretty concise:

public abstract String reference
Specifies a reference to the response type. The specified reference can be either local or remote and will be used as-is, and will override any specified response() class.

and I could not find examples of using this element...


On Friday, January 15, 2016 at 11:22:59 AM UTC-5, Ilia Baskine wrote:

tony tam

unread,
Jan 15, 2016, 1:41:53 PM1/15/16
to swagger-sw...@googlegroups.com
I really don’t know what you mean.  Please post more context about your question.

Reply all
Reply to author
Forward
0 new messages