Uploaded image for project: 'Nuxeo Conversions Service'
  1. Nuxeo Conversions Service
  2. NCS-7

Add Swagger documentation

    XMLWordPrintable

    Details

    • Type: User story
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: v0
    • Fix Version/s: v0
    • Component/s: Nuxeo Quarkus
    • Tags:
    • Sprint:
      l2it-11.1.2
    • Story Points:
      3

      Description

      As a developer, I need to have the REST API well documented, and up to date.

      One of the most common solution is to rely on Swagger and OpenAPI v3: https://swagger.io/specification/

      To validate, but it would be a good idea to rely on Swagger-core annotation module for generating the definition: https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations

      Acceptance: Is to have a proper endpoint on the base module that can display the Swagger definition.

        Attachments

          Activity

            People

            • Assignee:
              akervern Arnaud Kervern
              Reporter:
              akervern Arnaud Kervern
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: