Uploaded image for project: 'apiman (API Management)'
  1. apiman (API Management)
  2. APIMAN-307

Allow user to specify a swagger spec for describing their APIS

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: Major Major
    • None
    • 1.0.2.Final
    • None

      Eric, this is per our discussion, I didn't see an Jira issue:

      I think in the near term I can definitely add support in the API Manager
      REST services for managing of the swagger document for a particular
      Service. Non-UI support for simply adding/updating/removing a swagger
      document is very easy. Here's what I propose:

      {organizationId}

      /services/

      {serviceId}

      /versions/

      {version}

      /documentation

      This endpoint will support POST, PUT, and GET and will allow you to
      store the swagger document (or any other type of document we might want
      to support e.g. a WADL).

      In addition, I'll add an optional "documentationType" field to the
      service version (ServiceVersionBean) as an enum type:

      public enum ServiceDocumentationType {
      Swagger, WADL, Other;
      }

      I can use this now. I have prototyped this and it seems to work well, now I just need to retrieve it (the doc) using a REST API.

              ewittman@redhat.com Eric Wittmann
              christinalau28 Christina Lau (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: