$ref: Type is not defined about play-swagger HOT 4 CLOSED

I agree with Vasily. I spent two days trying to see the model in Swagger UI because I didn't add the domain package that i should. Some people have restricted knowledge of the terms (in my case i didn't understand the term domain package). Therefore in step1 of the instructions where we are instructed to put swaggerDomainNameSpaces := Seq("models") in the sbt file I I put it exactly identical to the instruction. My defined model case class was in the domain settings.models in my project.

It would be nice to add the following in this instruction:
If you have a case class defined under the package "something.models" and you would want to swagger to generate the definition for it (to access with #ref:definitions/), then make sure that the following is added in sbt: swaggerDomainNameSpaces := Seq("something.models")
If you have other case classes in other packages (e.g. other.models) the add them also in the above sequence like: swaggerDomainNameSpaces := Seq("something.models","other.models")

from play-swagger.

I am wondering if you included the models package as a domain package name when generating the swagger spec as in https://github.com/iheartradio/play-swagger#step-2?

from play-swagger.

I didn't. Thanks a lot!

Maybe it's a good idea to add a hint like "are you sure you added 'xxx' package as a domain one?"

from play-swagger.

@AngelosPrastitis thanks for your feedback. Would you help by submitting a PR to the readme file?

from play-swagger.