[SINGA-402] Rafiki - adding Swagger support

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Assignee: Unassigned
• Reporter: Moaz Reyad
• Created: 08/Nov/18 16:29
• Updated: 08/Dec/18 18:36

Description

Swagger is a software tool that helps in design, development, documenting and testing of RESTful web services.

It is proposed to add Swagger support for Rafiki web API. This will help u
sers and developers to run the web queries from Swagger UI directly instead of using curl or python commands. It will also help in documentation and testing.

An example file is provided with this issue to check if this proposal will be useful or not. The attached file has two working examples from the current Rafiki web API: /tokens and /models. 

To run the file:

$ docker run -p 80:8080 -e SWAGGER_JSON=/rafiki-api/rafiki.json -v /{PATH_TO_RAFIKI.JSON}:/rafiki-api swaggerapi/swagger-ui

(Replace /

{ PATH_TO_RAFIKI.JSON}

with the path to rafiki.json file in your machine)

Start Rafiki and open "localhost" in web browser to show Swagger UI for the API.