fineract-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [fineract] kangbreder commented on issue #629: Swagger documentation gsoc2019
Date Sat, 11 Jan 2020 10:01:03 GMT
kangbreder commented on issue #629: Swagger documentation gsoc2019
URL: https://github.com/apache/fineract/pull/629#issuecomment-573302138
 
 
   @vorburger Thank you. I have resolved the conflicts. 
   
   The response.json file is the OpenAPI specification file which is used to generate the
swagger-ui. 
   The already existing response.json file in src/main/resources/swagger-ui/ is the spec generated
with the request https://localhost:8443/fineract-provider/api/v1/swagger.json. Every time
a modification is done on the swagger docs or a new swagger doc is added, this spec needs
to be generated again at runtime and the response.json file as well updated so that the modifications
can be seen on the UI. 
   
   The io.swagger.core.v3.swagger-gradle-plugin is a plugin i had added to automatically generate
the specs during build time and not at run time. This was so that every time one builds on
the project, the response.json updates. But this did not work as expected. I had removed the
plugin from the build script. I am wondering how its still in there. probably while i have
rebasing and resolving conflicts, that came back in the script. I will remove the plugin.

   
   The other plugin org.hidetake.swagger.generator is used to generate code from the openAPI
spec file using swagger-codegen. So this does not generate response.json. It rather uses response.json
to generate client code. You
   
   @vorburger i think you have a nice idea. Is it possible to get the file and the swagger-ui
in the war? 
   That is actually what is needed to be done. Presently the file is manually generated and
updated each time. 
   
   
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message