Hi everyone!

Fineract-CN has no Swagger.

We have used Postman scripts to document the provisioning process,
these can be found here:
https://github.com/apache/fineract-cn-docker-compose

The advantage of Postman scripts over Swagger is that you often need to run
a lot of steps in a row and the output of some call needs to be used as
input parameter
to some next call. With Swagger you would need a lot of copy pasting around
but
with Postman you can use variables for storing and passing these values
around.

But of course having Swagger would help to identify what API-s exist at
first place.
Currently you have to read the code for that. You can find the
RestControllers of
each micro service from a locations like these:

https://github.com/apache/fineract-cn-identity/tree/develop/service/src/main/java/org/apache/fineract/cn/identity/rest
https://github.com/apache/fineract-cn-accounting/tree/develop/service/src/main/java/org/apache/fineract/cn/accounting/service/rest

Juhan

Kontakt Ed Cable (<[email protected]>) kirjutas kuupäeval E, 16. märts 2020
kell 07:38:

> Giorgio,
>
> Thanks for bringing this topic on list. I would love to hear from members
> of the community more technically-minded than me as to the ease of creating
> swagger doc formatted API for Fineract CN
>
> @Isaac Kamga <[email protected]> who lead efforts around our previous API
> doc efforts had to use SpringDocs due to the novelty and complexity of our
> microservices. Can others comment on the same?
>
> Our current GSOC idea on this topic,
> https://mifosforge.jira.com/wiki/spaces/RES/pages/1118175247/Google+Summer+of+Code+2020+Ideas#GoogleSummerofCode2020Ideas-LiveFineractCNAPIDocumentationasPartofDeveloperPortal,
>   links to
> the repo that Juhan created to house Isaac's work:
> https://github.com/aasaru/fineract-cn-api-docs
>
>
>
> On Sun, Mar 15, 2020 at 2:32 PM Giorgio Zoppi <[email protected]>
> wrote:
>
>> Hello Gents,
>> is there any swagger docs for fineract-cn?
>> BR,
>> Giorgio
>>
>
>
> --
> *Ed Cable*
> President/CEO, Mifos Initiative
> [email protected] | Skype: edcable | Mobile: +1.484.477.8649
>
> *Collectively Creating a World of 3 Billion Maries | *http://mifos.org
> <http://facebook.com/mifos>  <http://www.twitter.com/mifos>
>
>

Reply via email to