Best practice for incorporating Swagger-UI into a Scalatra project

[Mark Butler]

Apologies in advance as this may not be the best place to ask this question .. but I think Casualjim is involved in Swagger as well, right?

In my example before I had to manually include the Swagger-UI files:

https://github.com/butlermh/ScalatraFutureFileUpload/tree/master/src/main/webapp/swagger

My preference is not to "fork" open source projects like this - is there a better way to include the Swagger-UI code in Scalatra so I don't need to copy it to my repo?

I looked around and I found this:

https://github.com/metosin/ring-swagger-ui

It packages the Swagger-UI as a jar (cool!) but it's aimed at Clojure / Ring rather than Scalatra / sbt.

Any ideas about how I might go about using it with Scalatra?

Looking at the project structure document here

http://www.scalatra.org/2.3/getting-started/project-structure.html

Would I need to add a get method to my servlet to retrieve the swagger-UI resources from the classpath?

Or is there another way of doing this?

Thanks in advance if anyone has any suggestions,

Mark

[Ivan Porto Carrero]

it looks like that jar just uses resources, so you can use that jar by depending on it

Another option is to extract the jar with sbt into your webapp folder

This is how we do that with wars, https://github.com/scalatra/scalatra-sbt/blob/master/src/main/scala/org/scalatra/sbt/WarOverlayPlugin.scala

I'll talk to Tony to see if we can deploy a war of that so that it's much easier to integrate.

[Mark Butler]

Dear CasualJim / Ivan,

Thanks very much for looking into this :)

I did a bit more digging and I found another way of doing this.

Packaging web resources in this way is a common problem e.g. Bootstrap, JQuery etc so the Webjars project is a standard way of solving it - see this introduction

http://www.jamesward.com/2012/04/25/introducing-webjars-web-libraries-as-managed-dependencies

and the Webjars repository

http://www.webjars.org/

Webjars does have a jar for Swagger-UI:

https://github.com/webjars/swagger-ui

Webjars works with Play because it can serve static assets from Jar files. Luckily Ji Zhang has described a way to do this with Scalatra:

http://shzhangji.com/blog/2014/05/27/use-webjars-in-scalatra-project/

If anyone else is interested, I updated my example to use this approach:

https://github.com/butlermh/ScalatraFutureFileUpload

Thanks again for your support! Very best,

Mark

--
You received this message because you are subscribed to a topic in the Google Groups "scalatra-user" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/scalatra-user/rr1ciqI8BqE/unsubscribe.
To unsubscribe from this group and all its topics, send an email to scalatra-use...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.