[FINERACT-838] Swagger generated client libraries

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.4.0
• Assignee: Chinmay Kulkarni
• Reporter: Michael Vorburger
• Created: 19/Jan/20 14:38
• Updated: 17/Oct/20 14:21
• Resolved: 26/Aug/20 00:34

Description

In the review discussion of the first Swagger PR https://github.com/apache/fineract/pull/629 (which got superseded by https://github.com/apache/fineract/pull/695), this came up:

The other plugin org.hidetake.swagger.generator is used to generate code from the openAPI spec file using swagger-codegen. So this does not generate response.json. It rather uses response.json to generate client code.

and

think i had explained the usage of this in my gist https://gist.github.com/kangbreder/034f47e2e8015cee10b48b7c5f1b8df1, generating client libraries and language-specific SDKs in languages such as java and angular from swagger specification file. This was part of the goals of the project listed in https://mifosforge.jira.com/wiki/spaces/RES/pages/812810251/Google+Summer+of+Code+2019+Ideas.

Having (Swagger automatically generate!) client libraries in Java (and even other languages?!) seems like a cool idea. It's also something that perhaps needs a bit more investigation than only adding the respective Gradle plugin. If we actually do do this, after having done all of the work in the other Sub Tasks, then I think we would have to include sample code in the repo building against the generated client libraries to test and illustrate their usage. We would also have to publish those client libraries, e.g. as downloadable JAR from the release page (or later even made available on Maven central). It would perhaps be clearest if there was another directory in the Fineract source tree, next to and outside of not inside, the fineract-provider (which is the "server") for this purpose.

kangbreder awasum sanyam (sanyam96 ?) FYI

Issue Links

• incorporates: FINERACT-1100 Swagger CodeGen WARN i.s.c.v.g.java.AbstractJavaCodegen - New (reserved word) cannot be used as model name. Renamed to ModelNew
• incorporates: FINERACT-1102 Swagger Codegen Client JAR should be available on a Maven repo
• incorporates: FINERACT-1101 Swagger CodeGen Test Build using Gradle instead of Maven
• is duplicated by: FINERACT-996 Fineract Java Client API library
• relates to: FINERACT-996 Fineract Java Client API library
• links to: GitHub Pull Request #1203
• links to: GitHub Pull Request #1206
• links to: GitHub Pull Request #1226
• links to: GitHub Pull Request #1228
• links to: GitHub Pull Request #1229