fineract-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [fineract] vorburger commented on a change in pull request #1206: FINERACT-838 Added Swagger Codegen Support
Date Mon, 27 Jul 2020 08:29:45 GMT

vorburger commented on a change in pull request #1206:
URL: https://github.com/apache/fineract/pull/1206#discussion_r460728456



##########
File path: README.md
##########
@@ -263,6 +263,28 @@ API clients (Web UIs, Mobile, etc.)
 * https://github.com/openMF has more related proejcts
 
 
+Generate Apache Fineract API Client
+============
+
+Apache Fineract supports client code generation using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen).
Project supports [all clients](https://github.com/swagger-api/swagger-codegen#overview) supported
by Swagger Codegen. It uses [OpenAPI Specification Version 3.0.3](https://swagger.io/specification/).
+
+To generate code, execute the following commands:
+
+- **./gradlew build**
+- **./gradlew generateSwaggerCode**
+
+The client code will be generated in the directory **build/swagger-code-fineract**
+
+To build the generated code:
+
+- Navigate to **build/swagger-code-fineract** directory
+- **./gradlew build**
+
+To customize the generated code:
+
+- Open **fineract-provider/config/swagger/config.json**
+- Refer to [this](https://gist.github.com/Grandolf49/2d222c3d1d0b834ad8f02b5fde8b4c14) for
available options in config.json

Review comment:
       If you move it to a separate MD docs file, you could just "inline" your entire Gist?
Better. Actually, perhaps even better you could link to the appropriate docs page of Swagger
CodeGen where they document this? Assuming they have proper doc! :imp: That way, it stays
up to date, as we'll upgrade the plugin in the future.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message