[
https://issues.apache.org/jira/browse/LIVY-254?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17090363#comment-17090363
]
Antonio Murgia edited comment on LIVY-254 at 4/23/20, 8:20 AM:
---------------------------------------------------------------
A colleague of mine tried doing the same on an internal project with Akka Http.
He had no luck too. I think that older scala HTTP framework/libraries have very
limited support to autogenerating swagger specs. I think the only way to go is
the detached one. I will draft an Open API spec, "converting" the markdown
specification that is currently part of the docs.
was (Author: tmnd91):
A colleague of mine tried doing the same on an internal project with Akka Http.
He had no luck too. I think that older scala HTTP framework/libraries have very
limited support to autogenerating swagger specs. I think the only way to go is
the detached one.
> 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)
