Page tree
Skip to end of metadata
Go to start of metadata

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 developers build apps on top of Apache Fineract CN platform.

Running the unit tests in the component-test module to generate snippets used for documentation involves you assigning values to the snippets, sourceDir and outputDir variables of the 'asciidoctor' task in component-test module's build.gradle file. 

  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

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

DepositApiDocumentation.java

fineract-cn-payroll

PayrollApiDocumentation.java

fineract-cn-teller

TellerApiDocumentation.java

  • No labels