hngprojects / hng_boilerplate_golang_web

Apache License 2.0
77 stars 49 forks source link

Chore: add swagger doc #291

Closed Ajinx1 closed 1 month ago

Ajinx1 commented 1 month ago

Description

Added Swagger documentation to the project to provide a clear and interactive API documentation interface. This includes configuring the Swagger UI and defining the API endpoints in the swagger.yaml file.

How Has This Been Tested?

Tested the Swagger UI integration locally by running the application and navigating to the /api/docs/index.html endpoint. Verified that all API endpoints are correctly documented and accessible via the Swagger UI.

Screenshots (if appropriate - Postman, etc):

image image

Types of changes

Checklist: