feat: add initial Flask-Smorest OpenAPI configuration - #207
Closed
Shikha18Shukla wants to merge 1 commit into
Closed
feat: add initial Flask-Smorest OpenAPI configuration#207Shikha18Shukla wants to merge 1 commit into
Shikha18Shukla wants to merge 1 commit into
Conversation
|
@Shikha18Shukla is attempting to deploy a commit to the himanshipathak-240263-3015's projects Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Author
|
Hi! @Him-an-shi , I checked the failing Quality Gate, and it looks like the failure is due to the GitHub Actions workflow rather than the changes in this PR. The workflow is using
I don't think this is something I can resolve from my fork. Please let me know if you'd like me to make any changes on my side. |
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.
📌 Summary
This PR adds the initial Flask-Smorest/OpenAPI configuration to the backend, laying the foundation for future Swagger API documentation without changing any existing API behavior.
✨ Changes Made
Added Flask-Smorest integration.
Configured OpenAPI metadata:
API_TITLEAPI_VERSIONOPENAPI_VERSIONConfigured Swagger UI endpoint (
/docs).Initialized the Flask-Smorest
Apiobject.Prepared the backend for future API documentation using Flask-Smorest.
🧪 Testing
📋 Notes
The current backend defines its routes directly using
@app.route, so automatic endpoint documentation will require a future migration to Flask-Smorest Blueprints. This PR focuses on establishing the initial OpenAPI configuration as the first step toward that goal.Closes #207