dipeshdulal/clean-gin

Add swagger documentation for API

dipeshdulal opened this issue · 4 comments

Swagger Documentation for clean-gin

Fimeo commented

In order to continue the template with a swagger documentation. I propose to use an OpenApi v3 interface contract in json format in an api folder: swagger.json.

Moreover, it could be interesting to add a schema validator like https://github.com/getkin/kin-openapi on the requests made on the server through the creation of a middleware.

@Fimeo
Thank you. Didn't know about kin-openapi project.
Looks interesting and useful.

So, kin-openapi can validate request inputs and response output from the openapi schema as well or just validate schema only? 🤔

Fimeo commented

Wow. 🤩
This really looks useful.
I will try to integrate with our architecture soon. 🏃 💨