DonGuillotine/AT100DaysChallenge

Implement Django REST Framework for API Development

Ouverte

#1 ouverte le 24 janv. 2025

Voir sur GitHub
 (6 commentaires) (0 réaction) (0 personne assignée)Python (1 fork)auto 404
backendenhancementgood first issue

Métriques du dépôt

Stars
 (2 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Convert the existing Django backend into a REST API using Django REST Framework (DRF).

Tasks:

  • Install djangorestframework and add to requirements.txt
  • Configure DRF in Django settings
  • Create serializers for Book and BookChunk models
  • Implement API viewsets for models
  • Set up API routing with DRF router
  • Add API documentation using drf-spectacular or drf-yasg
  • Create basic API endpoints:
    • GET /api/books/ - List all books
    • GET /api/books/{id}/ - Get specific book details
    • GET /api/books/{id}/chunks/ - Get book chunks

Guide contributeur

Direction de recherche
Suivez les étapes : installez djangorestframework, configurez les paramètres, créez des sérialiseurs, des viewsets, configurez le routeur et ajoutez de la documentation avec drf spectacular ou drf yasg.
Stack technique
pythondjango
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonDjango
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75