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

Edward Cable updated FINCN-6:
-----------------------------
    Labels: GSoC2018  (was: )

> Fineract CN REST API Documentation
> ----------------------------------
>
>                 Key: FINCN-6
>                 URL: https://issues.apache.org/jira/browse/FINCN-6
>             Project: Fineract Cloud Native
>          Issue Type: New Feature
>            Reporter: Edward Cable
>            Priority: Major
>              Labels: GSoC2018
>
> Our newest generation architecture, Apache Fineract CN has a set of REST APIs 
> that are not documented yet. Given that the architecture is 
> microservices-based, Spring REST Docs will be the chosen tool of choice to 
> overcome limitations of static documentation:
>  # Live documentation that is accurate, based on Test-driven development and 
> does not need to be maintained manually in parallel to the source code which 
> actually defines the REST API, and therefore can stay in sync
>  # It will be live and you won't have to set up a REST tool such as e.g. 
> [Postman|https://www.getpostman.com/] &; Co. to "explore" it. 
> The goal of this project is address this by using _[Spring REST 
> Docs|http://projects.spring.io/spring-restdocs/]__;_ 
>  
>  # Spring MVC Test : 
> [https://docs.spring.io/spring/docs/current/spring-framework-reference/testing.html]
>  
>  # Spring REST Docs : [https://spring.io/guides/gs/testing-restdocs/] 
>  # Asciidoctor : [http://asciidoctor.org/] 



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

Reply via email to