Swagger Documentation Of Fineract API on SelfLoansApiResource.java Class
Overview & Objectives: Annotate the SelfLoansApiResource.java with Swagger Annotations and in the field description and for the specific values for the annotation can easily be found in the current documentation.
Description: Don't lose any documentation that's already on the current REST API docs, maintain it's human readable comments (by moving that into JavaDoc/annotations in code which SpringFox/Swagger exploit), the "sections", etc
Helpful Skills: Swagger, Java, REST, Git, Gradle.
Please Note: -> All the Swagger Documentation Pull Request should be created on Branch "GCI-swagger-integration" https://github.com/Sanyam96/incubator-fineract/tree/GCI-swagger-integration
Some Information about Swagger Documentation is given below ;)
Swagger is used for the dynamic documentation of REST API for Apache Fineract which can easily replace apiLive.htm (the current documentation)
In most of our cases, we are using @Api, @ApiOperation, @ApiImplicitParams, @ApiResponses and other Swagger Annotations for dynamic documentation of Fineract API’s
For Information about Swagger Annotations refer Swagger-Core Annotations.
Refer the Pull Request #409 on branch "swagger-documentation-integration" to get details about the integration of Swagger on Fineract and how Annotation are used in the Pull Request.
Follow more on the Documentation for Integration of Swagger on Fineract and how to apply swagger on Fineract at [ https://goo.gl/6cHv8F ]