Create interactive documentation for REST API

[mcupak]

This should be incorporated as a page in the client.

I personally like: http://www.mashery.com/product/io-docs.
A demo e.g. here: http://developer.rottentomatoes.com/io-docs.
A similar project is Swagger, which may have better Java integration: http://swagger.io/

[geekDisha]

Dear @mcupak,
I am working on this feature. I am using Swagger for Java with JAX-RS integration.
Regards

[geekDisha]

Hi @mcupak , I have created a pull request which implements the basic feature for a very simple interactive documentation of a simple alleles get request. PFA for screenshots.

[mcupak]

@geekDisha Thanks, looks very nice, this is exactly what I had in mind. Let's keep the PR open and just add new stuff there, I'll merge it when it's more or less finalized.

One thing that I'm wondering about is if we need all those Swagger UI CSS and JS files as part of our codebase. Can you please investigate if it would work with a WebJars Maven dependency instead?

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

[geekDisha]

@mcupak : Sure. I will try to investigate if it could work with a Webjar Maven dependency and get back to you with inputs.