[
https://issues.apache.org/jira/browse/LIVY-254?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17087423#comment-17087423
]
Antonio Murgia commented on LIVY-254:
-------------------------------------
I tried giving a shot to this but I found 2 issues:
# I don't know what I'm doing wrong, but I cannot get as json the description
of every method, only of top level paths (i.e. `sessions`)
# Scalatra 2.3.x support swagger definition 1.2, which is quite outdated, the
first release of Scalatra which supports swagger 2 is 2.6.x but it carries a
lot of other updated dependencies (json4s, scalatest (3) and mockito (2))
Is anyone which has more experience than me with Scalatra and swagger willing
to have a look at what's happening? Thanks
/cc [~ajbozarth]
> Propose to add Swagger doc support for Livy REST API
> ----------------------------------------------------
>
> Key: LIVY-254
> URL: https://issues.apache.org/jira/browse/LIVY-254
> Project: Livy
> Issue Type: New Feature
> Components: Docs
> Affects Versions: 0.3
> Reporter: Saisai Shao
> Priority: Major
>
> Current docs manually defines REST APIs, with the change of APIs the document
> may be obsolete, so we should have a program way to automatically generate
> REST API definitions.
> Swagger (http://swagger.io/) is a powerful tools for REST APIs documentation,
> it has a UI to show and try REST APIs in a very convenient way
> (http://petstore.swagger.io/). Also Scalatra already supports generating
> Swagger definition (http://www.scalatra.org/2.2/guides/swagger.html). So here
> I'd like to propose to add Swagger doc support for Livy REST APIs.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
