Set Up Swagger API Documentation #14
Description
📝 Description
This ticket focuses on integrating Swagger API documentation into the project. The documentation will provide an interactive UI to explore and test the authentication API endpoints directly from the browser.
🎯 Expected Deliverables
1️⃣ Install Required Dependencies
- Use drf-spectacular or drf-yasg to generate OpenAPI documentation.
- Ensure the package is installed via Poetry.
2️⃣ Configure Swagger in Django
- Set up automatic API documentation generation from Django REST Framework (DRF).
- Ensure API schemas are correctly generated from serializers and viewsets.
3️⃣ Create API Documentation Endpoints
- Add the following Swagger and ReDoc UI endpoints:
| Endpoint | Description |
|---|---|
/api/docs/swagger/ |
Interactive Swagger UI |
/api/docs/redoc/ |
ReDoc API documentation |
- Ensure both endpoints provide a structured and interactive view of the API.
4️⃣ Ensure Authentication Support in Swagger
- Allow JWT authentication inside the Swagger UI.
- Users should be able to input their tokens to test authenticated requests.
5️⃣ Update Project Settings
- Add configuration settings for API documentation.
- Ensure the documentation auto-updates when new endpoints are added.
✅ Acceptance Criteria
- Swagger UI is accessible at
/api/docs/swagger/. - ReDoc documentation is accessible at
/api/docs/redoc/. - API documentation auto-generates from DRF views and serializers.
- JWT authentication works inside Swagger UI.