💡 Description
The backend currently does not have an OpenAPI configuration, making it difficult to extend the project with interactive API documentation in the future.
This issue adds the initial Flask-Smorest/OpenAPI setup by configuring the Flask application with the required API metadata and enabling the Swagger UI endpoint. This lays the foundation for documenting API routes incrementally without affecting existing functionality.
🎯 Motivation
- Prepare the backend for OpenAPI documentation
- Enable Swagger UI support for future API documentation
- Centralize API metadata configuration
- Make future endpoint documentation easier to implement
📋 Scope
- Add Flask-Smorest to the backend
- Configure OpenAPI metadata (
API_TITLE, API_VERSION, OPENAPI_VERSION)
- Configure Swagger UI endpoint (
/docs)
- Initialize the Flask-Smorest
Api object
- Add comments describing future migration to documented Blueprints (if needed)
✅ Acceptance Criteria
📂 Expected Areas
backend/
├── app.py
└── requirements.txt
🏷️ Labels
ADVENTURER ELUSoC Feature Documentation
💡 Description
The backend currently does not have an OpenAPI configuration, making it difficult to extend the project with interactive API documentation in the future.
This issue adds the initial Flask-Smorest/OpenAPI setup by configuring the Flask application with the required API metadata and enabling the Swagger UI endpoint. This lays the foundation for documenting API routes incrementally without affecting existing functionality.
🎯 Motivation
📋 Scope
API_TITLE,API_VERSION,OPENAPI_VERSION)/docs)Apiobject✅ Acceptance Criteria
/docs📂 Expected Areas
backend/
├── app.py
└── requirements.txt
🏷️ Labels
ADVENTURERELUSoCFeatureDocumentation