Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Apache Fineract CN is an application framework for digital financial services, a system to support nationwide and cross-national financial transactions and help to level and speed the creation of an inclusive, interconnected digital economy for every nation in the world.

The API Documentation helps  helps developers build apps on top of Apache Fineract CN platform.

...

  1. Run each of the unit tests in the test classes as indicated in table below so that passing unit tests get snippets generated in snippets folder ( 'build/doc/generated-snippets/' by default ). The table below shows documented services and corresponding test classes containing updated unit tests.

  2. Create an api-docs.adoc file using this https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ in sourceDir ( 'build/doc/asciidoc/' by default ) which references your recently generated snippets.

  3. Run ‘gradle asciidoctor' to get the api-docs.html file generated in the outputDir folder ( 'build/doc/html5/' by default )

This table will be updated in case more files are changed for API documentation purposes.

...


Service

Concerned Test Classes

fineract-cn-identity

TestUsers.java and TestRoles

IdentityApiDocumentation.java

fineract-cn-office

EmployeeApiDocumentation.java and OfficeApiDocumentation.java

fineract-cn-customer

CustomerApiDocumentation.java and IdentificationApiDocumentation.java

fineract-cn-group

GroupApiDocumentation.java

fineract-cn-accounting

TransactionTypeApiDocumentation.java, JournalEntryApiDocumentation.java, AccountApiDocumentation.java and LedgerApiDocumentation.java

fineract-cn-portfolio

TestCases.java, TestChargeDefinitions.java, TestPatterns.java, TestProducts.java, TestTaskDefinitions.java and TestTaskInstances.java

fineract-cn-deposit-account-management

TestActions

DepositApiDocumentation.java

,  TestProductDefiniton

fineract-cn-payroll

PayrollApiDocumentation.java

and TestProductInstance.java

fineract-cn-

payroll

teller

TestPayrollConfigutation

TellerApiDocumentation.java

fineract-cn-

teller

notification

TestTellerManagement

EmailApiDocumentation.java

and TestTellerOperation

,SmsApiDocumentation.java