swagger-core support

[seratch]

Swagger is a pretty useful library for RESTful APIs documentation.

https://github.com/wordnik/swagger-core

If integrating swagger with Skinny apps is easiler than Scalatra directly, it's very cool.

http://scalatra.org/2.2/guides/swagger.html

[seratch]

scalatra-swagger for Scalatra 2.2 doesn't work with json4s 3.2.5 or higher. I just created a prototype but couldn't design easy-to-use APIs. We may need more time to suport swagger.

[sixman9]

Hi @seratch,
Do you think you could re-attempt the addition/example of Swagger support again, as the latest Scalatra 2.3.x Swagger Support page now seems to suggest a version of json4s greater than 3.2.5 in current use (3.2.9 to be exact):

(exert from Swagger Support)

Dependencies

Don't forget to add the JSON libraries to your project/build.scala file to make this work:

"org.scalatra" %% "scalatra-json" % "2.3.0",
"org.json4s" %% "json4s-native" % "3.2.9",

I am aware that you currently use '"json4s-native" % "3.2.10"' within Skinny, I'm just hoping there's not too much of a difference between the two json4s versions.

[seratch]

@sixman9
Sorry for late reply. I believe that scalatra-swagger's json4s issue no longer exists. scalatra-swagger will work with different version of json4s.

I still have passion to create swagger module for Skinny. I hope we'll be able to provide easy-to-use APIs for Skinny users.

[metasim]

+1 for this feature.

[josgraha]

If you were to implement this feature where and how would be the best way to do it?

[seratch]

Writing annotations that are unused for application's behavior and they're needed only for swagger api-docs is a verbose and uncertain approach.

Just an idea. Capturing requests and building api-docs (maybe it won't be complete, though) may be reasonable enough.