[FINERACT-834] documenting Swagger use on README

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.2.0, 1.3.0, 1.4.0
• Fix Version/s: 1.5.0
• Component/s: SDK
• Labels: beginner documentation swagger
• Assignee: Manthan Surkar
• Reporter: Michael Vorburger
• Created: 19/Jan/20 14:07
• Updated: 25/Feb/21 08:12
• Resolved: 25/Sep/20 13:27

Description

Based on some of the discussion in https://github.com/apache/fineract/pull/629 (which got superseded by https://github.com/apache/fineract/pull/695), I think it would be very useful to have a short line (or a or two paragraph, max) in https://github.com/apache/fineract/blob/develop/README.md#apache-fineract-platform-api which simply explains how one actually may currently use the Swagger UI, as it currently is.

I will just be completely honest and admit that personally I do not actually know how! Is there a special URL one has to access? Does one need to locally install anything?

kangbreder would you like to do this? Please do raise 1 small PR with ONLY this README change.

awasum sanyam (sanyam96 ?) FYI

Issue Links

• Blocked: FINERACT-1305 Release Apache Fineract v1.5.0
• relates to: FINERACT-733 Swagger Documentation for Fineract API's
• links to: GitHub Pull Request #1310
• links to: GitHub Pull Request #1349