feat: add Swagger UI and OpenAPI spec for backend APIs#149
Open
antcybersec wants to merge 1 commit into
Open
Conversation
Expose /api-docs and /openapi.yaml, and add a complete OpenAPI definition covering auth and todo endpoints with security schemes and standardized error responses. Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #143
Summary
GET /api-docsand exposed the raw spec atGET /openapi.yaml.backend/api/openapi.yamlcovering all existing REST endpoints, request bodies, response schemas, and auth requirements.What Changed
backend/internal/routes/routes.go:router.StaticFile("/openapi.yaml", "./api/openapi.yaml")/api-docsroute to render Swagger UIbackend/api/openapi.yaml:GET /healthPOST /signupPOST /loginPOST /api/user/logoutGET /api/user/todoPOST /api/user/todoPATCH /api/user/todo/{id}DELETE /api/user/todo/{id}summary,description,tags)400,401,404,500)BearerAuth) and applied it to protected endpointsAcceptance Criteria Mapping
openapi.yaml.openapi validation: ok)./api-docsand/openapi.yamlfor local/staging use.Test Plan
http://localhost:8080/api-docsPOST /loginto get a token, click Authorize, and test protected todo endpointshttp://localhost:8080/openapi.yamlis accessible and renders raw spec