Uploaded image for project: 'Livy (READ-ONLY)'
  1. Livy (READ-ONLY)
  2. LIVY-254

Propose to add Swagger doc support for Livy REST API

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 0.3
    • Fix Version/s: None
    • Component/s: Docs
    • Labels:
      None

      Description

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              jerryshao Saisai Shao
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: