You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@fineract.apache.org by Giorgio Zoppi <gi...@gmail.com> on 2020/03/15 21:32:13 UTC
Swagger doc for fineract-cn
Hello Gents,
is there any swagger docs for fineract-cn?
BR,
Giorgio
Re: Swagger doc for fineract-cn
Posted by Ed Cable <ed...@mifos.org>.
Hi Giorgio, checking in on this thread to see if you made any progress on
swagger for Fineract CN APIs.
Once we have the APIs in the Swagger format, I can share access to a
Postman developer portal we are trying to set up where we can import all
these APIs in swagger format and publish as more of a developer portal
format.
Ed
On Mon, Mar 16, 2020, 00:21 Giorgio Zoppi <gi...@gmail.com> wrote:
> Ok,
> i will try some
>
> El lun., 16 mar. 2020 a las 7:16, Juhan Aasaru (<aa...@gmail.com>)
> escribió:
>
>> Hi everyone!
>>
>> Fineract-CN has no Swagger.
>>
>
>
> Ok. I will try some experiments during the week. The rationale is interop,
> with swagger is easier to see the interop (accessing microservices from
> other languages) and
> the structure of your fineract-cn, and learning how it works.
> Best Regards,
> Giorgio
>
>
>
Re: Swagger doc for fineract-cn
Posted by Giorgio Zoppi <gi...@gmail.com>.
Ok,
i will try some
El lun., 16 mar. 2020 a las 7:16, Juhan Aasaru (<aa...@gmail.com>)
escribió:
> Hi everyone!
>
> Fineract-CN has no Swagger.
>
Ok. I will try some experiments during the week. The rationale is interop,
with swagger is easier to see the interop (accessing microservices from
other languages) and
the structure of your fineract-cn, and learning how it works.
Best Regards,
Giorgio
Re: Swagger doc for fineract-cn
Posted by Juhan Aasaru <aa...@gmail.com>.
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 (<ed...@mifos.org>) 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 <ik...@apache.org> 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 <gi...@gmail.com>
> wrote:
>
>> Hello Gents,
>> is there any swagger docs for fineract-cn?
>> BR,
>> Giorgio
>>
>
>
> --
> *Ed Cable*
> President/CEO, Mifos Initiative
> edcable@mifos.org | 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>
>
>
Re: Swagger doc for fineract-cn
Posted by Ed Cable <ed...@mifos.org>.
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 <ik...@apache.org> 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 <gi...@gmail.com>
wrote:
> Hello Gents,
> is there any swagger docs for fineract-cn?
> BR,
> Giorgio
>
--
*Ed Cable*
President/CEO, Mifos Initiative
edcable@mifos.org | 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>
Re: Swagger doc for fineract-cn
Posted by Awasum Yannick <aw...@apache.org>.
No, will you like to implement it?
On Sun, Mar 15, 2020, 22:32 Giorgio Zoppi <gi...@gmail.com> wrote:
> Hello Gents,
> is there any swagger docs for fineract-cn?
> BR,
> Giorgio
>