Replace Swagger with more native solution

Description

RAML to Swagger conversion has run into a number of issues:

  • Representing mutliple types of data (application/json and text/csv)

  • Showing examples and JSON Schema

  • Conversion library has stopped working in NPM

Solution will be to replace our conversion to Swagger docs with a more native solution like API console

AC:

  • Add API Console to Reference Data service - build artifact should be an HTML page that allows live docs at /referencedata/docs (same pattern as current Swagger)

  • Ensure live docs work against which every base url they're deployed against (e.g. test.openlmis.org, uat.openlmis.org, etc)

  • Make sure to remove all Swagger dependencies in our services as a part of this ticket.

  • Have solution code reviewed and post to dev forum

  • If no critical issues are found, repeat to all other Ref Distro services with live docs.

Status

Assignee

Łukasz Lewczyński

Reporter

Mateusz Kwiatkowski

Labels

Story Points

5

Time tracking

60h

Sprint

None

Fix versions

Priority

Blocker