Uploaded image for project: 'Teiid'
  1. Teiid
  2. TEIID-3615

Add a api-docs page with Swagger-UI in REST Service Through VDB

    XMLWordPrintable

Details

    • Feature Request
    • Resolution: Duplicate
    • Major
    • None
    • 8.12
    • None
    • None

    Description

      With document [1], we can use REST API to access the data in VDB, for example, there are 4 procedures defined in PortfolioRest VDB as [2] under 'Rest' Model:

      • foo
      • getAllStocks
      • getAllStockById
      • getAllStockBySymbol

      Correspondingly, there are 4 api:

      With Swagger UI, it's easy to add a api-doc page for all api, [3] is a example.

      [1] https://docs.jboss.org/author/display/TEIID/REST+Service+Through+VDB
      [2] https://raw.githubusercontent.com/kylinsoong/teiid-quickstarts/master/dynamicvdb-restservice/src/vdb/portfolio-rest-vdb.xml
      [3] http://petstore.swagger.io/

      Attachments

        Issue Links

          Activity

            People

              kylinsoong.1214@gmail.com Kylin Soong (Inactive)
              kylinsoong.1214@gmail.com Kylin Soong (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: