[
https://issues.apache.org/jira/browse/SINGA-402?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16713750#comment-16713750
]
Moaz Reyad commented on SINGA-402:
----------------------------------
I would like to add also that if we have swagger file for the API, we can use
[ReDoc|https://github.com/Rebilly/ReDoc] to add the API documentation to
[SINGA website|http://singa.apache.org/].
See for example the [REST API for Apache
Pulsar|https://pulsar.apache.org/en/admin-rest-api/].
> Rafiki - adding Swagger support
> -------------------------------
>
> Key: SINGA-402
> URL: https://issues.apache.org/jira/browse/SINGA-402
> Project: Singa
> Issue Type: Improvement
> Reporter: Moaz Reyad
> Priority: Major
> Attachments: rafiki.json
>
>
> [Swagger|http://swagger.io/] 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:
> {code}
> $ docker run -p 80:8080 -e SWAGGER_JSON=/rafiki-api/rafiki.json -v
> /{PATH_TO_RAFIKI.JSON}:/rafiki-api swaggerapi/swagger-ui
> {code}
> (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.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
