GSOC'17:swagger and swagger UI integration on fineract-provider

2017-08-27 23:22:52 +05:30
parent df16dc3cad
commit b5d9429926
125 changed files with 6023 additions and 287 deletions
@@ -99,5 +99,8 @@

 	<import resource="spmContext.xml"/>

+	<import resource="swagger.xml"/>
+
 	<import resource="notificationContext.xml"/>
+
 </beans>
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements. See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership. The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied. See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
+
+
+
+    <bean id="apiListingResource" class="io.swagger.jaxrs.listing.ApiListingResource"/>
+    <bean id="swaggerSerializers" class="io.swagger.jaxrs.listing.SwaggerSerializers" scope="singleton"/>
+
+    <bean id="beanConfig" class="io.swagger.jaxrs.config.BeanConfig">
+        <property name="title" value="Apache Fineract API Documentation"/>
+        <property name="version" value="1.0.0" />
+        <property name="description" value="Apache Fineract is a secure, multi-tenanted microfinance platform. &lt;br /&gt;
+
+            The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform. The reference app [  https://demo.openmf.org  ] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
+
+            &lt;br/&gt;The API
+
+               is organized around REST [ https://en.wikipedia.org/wiki/Representational_state_transfer ]
+              &lt;br/&gt; Find out more about Apache Fineract on [ https://demo.openmf.org/api-docs/apiLive.htm#top ]
+
+            &lt;br/&gt; You can Try The API From Your Browser itself at [ https://demo.openmf.org/api-docs/apiLive.htm#interact ]
+
+            &lt;br/&gt; The Generic Options are available at [ https://demo.openmf.org/api-docs/apiLive.htm#genopts ]
+
+            &lt;br/&gt; Find out more about Updating Dates and Numbers at [ https://demo.openmf.org/api-docs/apiLive.htm#dates_and_numbers ]
+
+            &lt;br/&gt; For the Authentication and the Basic of HTTP and HTTPS refer [ https://demo.openmf.org/api-docs/apiLive.htm#authentication_overview ]
+
+            &lt;br/&gt; Check about ERROR codes at [ https://demo.openmf.org/api-docs/apiLive.htm#errors ]
+
+
+            &lt;br/&gt; &lt;br/&gt; Please refer to the old documentation for any documentation queries [ https://demo.openmf.org/api-docs/apiLive.htm ]
+
+            &lt;br/&gt;
+            ______________________________________________________________________________________________________________________________
+
+        "/>
+
+        <property name="license" value="Apache 2.0" />
+        <property name="schemes" value="https" />
+        <property name="host" value="https://demo.openmf.org" />
+        <property name="basePath" value="fineract-provider/api/v1"/>
+        <property name="termsOfServiceUrl" value="https://demo.openmf.org/api-docs/apiLive.htm"/>
+        <property name="contact" value="https://gitter.im/openMF/mifos"/>
+        <!--<property name="resourcePackage" value="io.swagger.resources"/>-->
+        <property name="resourcePackage" value="org.apache.fineract"/>
+        <property name="scan" value="true"/>
+    </bean>
+
+</beans>