Page History

...

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

Running the component tests 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 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 )

...