Make uRouting API compatible with Swagger Spec

[miere]

Swagger is the a broadly used API definition Specification which should help Kikaha developers to expose its REST APIs.

Definition of done:

• Expose the Swagger model and Swagger UI
• Allow Developers incorporate Swagger UI through webjars (depends on Allow "webjar" deployments #227)
• Generate classes from the swagger.json file.
• Generate the swagger.json from Kikaha endpoints and related POJOs

[jmilagroso]

1. Add to kikaha web project pom.xml:

        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>swagger-ui</artifactId>
            <version>3.0.10</version>
        </dependency>

2. Go to Swagger Editor, Online Editor (http://editor.swagger.io/#/) to create swagger.json (File -> Download as JSON), or use the sample swagger json.

3. Put the swagger JSON file to kikaha web project resources directory.

4. Create SwaggerResource to handle:

   • /api-docs/model
   • /api-docs/ui

5. Create SwaggerUIResource to handle:

   • /webjars/*

6. Open browser,

http://localhost:<kikaha port>/api-docs/ui

Please feel free to improve as needed.

[miere]

Hi @jmilagroso
Thank you for another great suggestion.

It seems like a very pragmatic approach, indeed, and I really think there could be an extra module that exposes, automatically, your API model.

Based on your suggestion, and a feedback I received from @sixman9 a few months ago, I've updated this issue with a DOD (definition of done). I believe I can deliver the first 2 items from DOD yet on 2.1.0 version.

Also, I've opened the #227 issue which should help you with webjars.

The last two items on the DOD will be finished on the 2.2.0 version.

Regards!