Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add swagger documentation for API #25

Open
dipeshdulal opened this issue Jul 30, 2021 · 4 comments
Open

Add swagger documentation for API #25

dipeshdulal opened this issue Jul 30, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dipeshdulal
Copy link
Owner

Swagger Documentation for clean-gin

@dipeshdulal dipeshdulal added the documentation Improvements or additions to documentation label Jul 30, 2021
@Fimeo
Copy link

Fimeo commented Feb 22, 2023

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.

@dipeshdulal
Copy link
Owner Author

@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
Copy link

Fimeo commented Feb 27, 2023 via email

@dipeshdulal
Copy link
Owner Author

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

@dipeshdulal dipeshdulal added the enhancement New feature or request label Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants