You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@fineract.apache.org by Ed Cable <ed...@gmail.com> on 2017/04/24 15:26:28 UTC
Fwd: [Mifos-developer] GSOC Application 2017 | REST API "live"
documentation using Swagger, SpringFox / Spring REST Docs
Sanyam had originally sent his proposal for feedback to the mifos-dev list.
Adding the fineract dev list now too.
Ed
---------- Forwarded message ----------
From: Sanyam Goel <sa...@gmail.com>
Date: Fri, Apr 14, 2017 at 1:12 AM
Subject: [Mifos-developer] GSOC Application 2017 | REST API "live"
documentation using Swagger, SpringFox / Spring REST Docs
To: mifos-developer@lists.sourceforge.net
Hi all,
I am a third-year undergraduate student at Bharati Vidyapeeth's College Of
Engineering, affiliated with Guru Gobind Singh Indraprastha University, New
Delhi, India. I am interested in contributing to open source world and
seeking an opportunity to start the career with GSOC 2017.
I have a special interest in frontend and backend Services. I have been
working on different platforms like JavaSE, JavaEE, Hibernate, Springs,
REST API, Android Development which demonstrate my skills and expertise in
the frontend, backend, and full-stack web development.
I would like to work on the Fineract project, currently, it has a
limitation that the apiLive.htm file has to be maintained manually with the
REST API which is hard to keep perfectly synchronized with the API. We can
use Swagger, Springfox to maintain documentation dynamically.
Swagger scans the code and exposes the documentation on some URL which
helps clients to consume the API and learn how to use the REST API or to
which HTTP methods to call on which URL or which input documents to send or
which status code to expect, etc..
Also, I am familiar with bad coding styles and practices which may cause
vulnerabilities such as not closing dB connections etc..
I would like to work on this project this summer under your thoughts and
guidance.
--
SANYAM GOEL
Information Technology,
Bharati Vidyapeeth's College Of Engineering, New Delhi, India
------------------------------------------------------------
------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
Mifos-developer mailing list
mifos-developer@lists.sourceforge.net
Unsubscribe or change settings at:
https://lists.sourceforge.net/lists/listinfo/mifos-developer
Re: [Mifos-developer] Fwd: GSOC Application 2017 | REST API "live"
documentation using Swagger, SpringFox / Spring REST Docs
Posted by Sanyam Goel <sa...@gmail.com>.
yes, I think Swagger UI and Swagger Editor will make the documentation
using the bottom-up approach and I think definitely it helps the developers
to consume the API more easily.
Looking forward to work on this project with Mifos Initiative this summer.
On Monday, April 24, 2017 at 11:44:27 PM UTC+5:30, Aleksandar Vidakovic
wrote:
>
> Hi Sanyam,
>
> ... great that you are interested in this task. I think the community
> would greatly benefit of this. The Swagger UI makes it really easy e. g. to
> do adhoc testing, but mainly this should make the maintenance of the
> documentation hopefully a lot easier.
>
> Let's keep in touch...
>
> Aleks
>
> On Mon, Apr 24, 2017 at 4:30 PM Ed Cable <edc...@gmail.com <javascript:>>
> wrote:
>
>> Sanyam had originally sent his proposal for feedback to the mifos-dev
>> list. Adding the fineract dev list now too.
>>
>> Ed
>> ---------- Forwarded message ----------
>> From: Sanyam Goel <sanyam....@gmail.com <javascript:>>
>> Date: Fri, Apr 14, 2017 at 1:12 AM
>> Subject: [Mifos-developer] GSOC Application 2017 | REST API "live"
>> documentation using Swagger, SpringFox / Spring REST Docs
>> To: mifos-d...@lists.sourceforge.net <javascript:>
>>
>>
>> Hi all,
>>
>> I am a third-year undergraduate student at Bharati Vidyapeeth's College
>> Of Engineering, affiliated with Guru Gobind Singh Indraprastha University,
>> New Delhi, India. I am interested in contributing to open source world and
>> seeking an opportunity to start the career with GSOC 2017.
>>
>> I have a special interest in frontend and backend Services. I have been
>> working on different platforms like JavaSE, JavaEE, Hibernate, Springs,
>> REST API, Android Development which demonstrate my skills and expertise in
>> the frontend, backend, and full-stack web development.
>>
>> I would like to work on the Fineract project, currently, it has a
>> limitation that the apiLive.htm file has to be maintained manually with the
>> REST API which is hard to keep perfectly synchronized with the API. We can
>> use Swagger, Springfox to maintain documentation dynamically.
>>
>> Swagger scans the code and exposes the documentation on some URL which
>> helps clients to consume the API and learn how to use the REST API or to
>> which HTTP methods to call on which URL or which input documents to send or
>> which status code to expect, etc..
>>
>> Also, I am familiar with bad coding styles and practices which may cause
>> vulnerabilities such as not closing dB connections etc..
>>
>> I would like to work on this project this summer under your thoughts and
>> guidance.
>>
>>
>> --
>> SANYAM GOEL
>> Information Technology,
>> Bharati Vidyapeeth's College Of Engineering, New Delhi, India
>>
>>
>> ------------------------------------------------------------------------------
>> Check out the vibrant tech community on one of the world's most
>> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
>> Mifos-developer mailing list
>> mifos-d...@lists.sourceforge.net <javascript:>
>> Unsubscribe or change settings at:
>> https://lists.sourceforge.net/lists/listinfo/mifos-developer
>>
>> ------------------------------------------------------------------------------
>> Check out the vibrant tech community on one of the world's most
>> engaging tech sites, Slashdot.org! http://sdm.link/slashdotMifos-developer
>> mailing list
>> mifos-d...@lists.sourceforge.net <javascript:>
>> Unsubscribe or change settings at:
>> https://lists.sourceforge.net/lists/listinfo/mifos-developer
>
>
Re: [Mifos-developer] Fwd: GSOC Application 2017 | REST API "live"
documentation using Swagger, SpringFox / Spring REST Docs
Posted by Aleksandar Vidakovic <ch...@monkeysintown.com>.
Hi Sanyam,
... great that you are interested in this task. I think the community would
greatly benefit of this. The Swagger UI makes it really easy e. g. to do
adhoc testing, but mainly this should make the maintenance of the
documentation hopefully a lot easier.
Let's keep in touch...
Aleks
On Mon, Apr 24, 2017 at 4:30 PM Ed Cable <ed...@gmail.com> wrote:
> Sanyam had originally sent his proposal for feedback to the mifos-dev
> list. Adding the fineract dev list now too.
>
> Ed
> ---------- Forwarded message ----------
> From: Sanyam Goel <sa...@gmail.com>
> Date: Fri, Apr 14, 2017 at 1:12 AM
> Subject: [Mifos-developer] GSOC Application 2017 | REST API "live"
> documentation using Swagger, SpringFox / Spring REST Docs
> To: mifos-developer@lists.sourceforge.net
>
>
> Hi all,
>
> I am a third-year undergraduate student at Bharati Vidyapeeth's College Of
> Engineering, affiliated with Guru Gobind Singh Indraprastha University, New
> Delhi, India. I am interested in contributing to open source world and
> seeking an opportunity to start the career with GSOC 2017.
>
> I have a special interest in frontend and backend Services. I have been
> working on different platforms like JavaSE, JavaEE, Hibernate, Springs,
> REST API, Android Development which demonstrate my skills and expertise in
> the frontend, backend, and full-stack web development.
>
> I would like to work on the Fineract project, currently, it has a
> limitation that the apiLive.htm file has to be maintained manually with the
> REST API which is hard to keep perfectly synchronized with the API. We can
> use Swagger, Springfox to maintain documentation dynamically.
>
> Swagger scans the code and exposes the documentation on some URL which
> helps clients to consume the API and learn how to use the REST API or to
> which HTTP methods to call on which URL or which input documents to send or
> which status code to expect, etc..
>
> Also, I am familiar with bad coding styles and practices which may cause
> vulnerabilities such as not closing dB connections etc..
>
> I would like to work on this project this summer under your thoughts and
> guidance.
>
>
> --
> SANYAM GOEL
> Information Technology,
> Bharati Vidyapeeth's College Of Engineering, New Delhi, India
>
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> Mifos-developer mailing list
> mifos-developer@lists.sourceforge.net
> Unsubscribe or change settings at:
> https://lists.sourceforge.net/lists/listinfo/mifos-developer
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdotMifos-developer
> mailing list
> mifos-developer@lists.sourceforge.net
> Unsubscribe or change settings at:
> https://lists.sourceforge.net/lists/listinfo/mifos-developer