DonGuillotine/AT100DaysChallenge

Implement Django REST Framework for API Development

Open

#1 opened on Jan 24, 2025

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (1 fork)auto 404
backendenhancementgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Follow the steps: install djangorestframework, configure settings, create serializers, viewsets, set up router, and add documentation using drf spectacular or drf yasw.
Tech stack
pythondjango
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonDjango
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75