feat: add Flask-Smorest OpenAPI configuration - #250
Closed
Shikha18Shukla wants to merge 1 commit into
Closed
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've completed the implementation for #201 and opened this PR. I would appreciate it if you could review it when you have time. If there are any changes or improvements you'd like me to make, please let me know and I'll address them promptly. Otherwise, if everything looks good, I'd be grateful if you could merge it. Thank you! 😊 |
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.
🌸 Description
This PR adds the initial Swagger/OpenAPI configuration to the Flask backend using Flask-Smorest, laying the foundation for interactive API documentation without affecting existing application behavior.
Changes made:
Flask-Smorestdependency torequirements.txt.API_TITLEAPI_VERSIONOPENAPI_VERSION/docs.Apiobject usingFlask-Smorest.@app.routeroutes to Flask-Smorest Blueprints for automatic endpoint documentation.The current backend routes continue to work as before. This change only establishes the OpenAPI infrastructure, making future API documentation easier to implement while keeping existing functionality unchanged.
Fixes #201
🛠️ Type of change
🔒 Privacy & Security (Crucial for Aarini)
✅ Checklist:
🤝 ECSoC / ELUSOC 2026