Thank you for the clarification. On Sun, Apr 7, 2019 at 5:48 PM Sanyam Goel <sanyam.bvco...@gmail.com> wrote:
> Hi Kang > > Swagger definition files can be easily accessible at /swagger.json and > /swagger.yaml at the context > root of the application by providing proper Authorization and Headers. See > guide for Using Rest client > <https://cwiki.apache.org/confluence/display/FINERACT/Using+rest+client+for+passing+api+requests> > for passing API requests > <https://cwiki.apache.org/confluence/display/FINERACT/Using+rest+client+for+passing+api+requests> > > For accessing new Swagger.json, you simply have to hit the endpoint as > shown below. It is the same as hitting any fineract API endpoint by REST > CLIENT. > > For example > i. [ https://localhost:8443/fineract-provider/api/v1/swagger.json ] > ii. [ https://localhost:8443/fineract-provider/api/v1/swagger.yaml ] > > Swagger definition files i.e., JSON file is mapped with the Swagger UI > which is in the static directory of the resources directory > <https://github.com/apache/fineract/tree/develop/fineract-provider/src/main/resources> > of fineract for User Interface for the automated documentation of FINERACT > REST API. > Swagger UI can easily be accessible at index.html > > Thanks, > Sanyam > > On Sat, Apr 6, 2019 at 5:18 PM Kang Breder <kangbre...@gmail.com> wrote: > >> Hello! >> >> I am working on this issue >> https://issues.apache.org/jira/browse/FINERACT-745. >> For the deprecated description field of the @Api, I have modified the >> BatchApiResource.java class locally by using the @tag definition for the >> description of the Batch API. I have then added the @tag definition to the >> @SwaggerDefinition and have also added the @tag reference to @Api. Please >> how can i test this change to see if the description actually appears on >> the generated documentation? or how do i generate the documentation from >> here in order to see the updates? I am not clear from the pdf detail >> document that was shared on the JIRA page. >> I will be grateful to get some help on this. >> >> Thank you! >> > > > -- > SANYAM GOEL > Profile: plu.us/sanyam96 > LinkedIn: https://goo.gl/NkmHkf > Github: https://goo.gl/STw1Rq > Hackerrank: https://goo.gl/va9Npm > +91-9818060934 >
