[jira] [Updated] (FINERACT-733) Swagger Documentation for Fineract API's

["Vishwas Babu A J (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/FINERACT-733?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vishwas Babu A J updated FINERACT-733:
--------------------------------------
    Description: 
The original documentation for Fineract is at [https://github.com/apache/fineract/blob/develop/api-docs/apiLive.htm.] This documentation was handcrafted to meet the following goals
 # Provide a detailed overview of the API design and common options (under "Overview" section of the main drop-down menu)
 # Help consumers to easily visualize related API's to quickly determine the scope of functionality supported by the system ( Ex: links to all loan related API's consolidated under the "Loan" section of the drop-down menu)
 # For each entity in the system, provide a meaningful description of what the entity represents in the real world (Ex: [https://demo.openmf.org/api-docs/apiLive.htm#glaccounts] )
 # For common fields associated with an entity, provide a meaningful description of what they represent and how they are to be used (Ex: [https://demo.openmf.org/api-docs/apiLive.htm#loans] , see the description and detailed explanation of fields like transactionProcessingStrategyId )
 # Provide a detailed overview of the functionality supported by each API call (especially when their usage is not obvious, see the detailed documentation for Batch API's at https://demo.openmf.org/api-docs/apiLive.htm#batch_api )
 # Provide examples of sample requests and responses for each API call

However, this documentation suffered a major drawback, i.e all of it was handwritten and was difficult for new committers to add to and maintain. It was also preferable that users be allowed to try out all API's from the documentation itself, which wasn't an option.

The newly added Swagger documentation aims to address these concerns. 

 

 

 

 

 

 

 

> Swagger Documentation for Fineract API's
> ----------------------------------------
>
>                 Key: FINERACT-733
>                 URL: https://issues.apache.org/jira/browse/FINERACT-733
>             Project: Apache Fineract
>          Issue Type: Improvement
>            Reporter: Vishwas Babu A J
>            Priority: Major
>             Fix For: 1.4.0
>
>
> The original documentation for Fineract is at [https://github.com/apache/fineract/blob/develop/api-docs/apiLive.htm.] This documentation was handcrafted to meet the following goals
>  # Provide a detailed overview of the API design and common options (under "Overview" section of the main drop-down menu)
>  # Help consumers to easily visualize related API's to quickly determine the scope of functionality supported by the system ( Ex: links to all loan related API's consolidated under the "Loan" section of the drop-down menu)
>  # For each entity in the system, provide a meaningful description of what the entity represents in the real world (Ex: [https://demo.openmf.org/api-docs/apiLive.htm#glaccounts] )
>  # For common fields associated with an entity, provide a meaningful description of what they represent and how they are to be used (Ex: [https://demo.openmf.org/api-docs/apiLive.htm#loans] , see the description and detailed explanation of fields like transactionProcessingStrategyId )
>  # Provide a detailed overview of the functionality supported by each API call (especially when their usage is not obvious, see the detailed documentation for Batch API's at https://demo.openmf.org/api-docs/apiLive.htm#batch_api )
>  # Provide examples of sample requests and responses for each API call
> However, this documentation suffered a major drawback, i.e all of it was handwritten and was difficult for new committers to add to and maintain. It was also preferable that users be allowed to try out all API's from the documentation itself, which wasn't an option.
> The newly added Swagger documentation aims to address these concerns. 
>  
>  
>  
>  
>  
>  
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)