drf
by pradeepcep
Coding Agents & IDEsBrief
Django REST Framework scaffolding best practices, and gotchas.
Description
What This Skill Does
Covers building REST APIs with Django REST Framework, including project setup, serializers, viewsets, routing, authentication, pagination, filtering, and query optimization. Includes guidance on common pitfalls like N+1 queries, silent permission bugs, and misplaced business logic.
Collects opinionated defaults and common pitfalls in one place so engineers avoid silent security bugs and performance problems that DRF does not surface on its own.
When to Use It
- Scaffolding a new Django REST API project from scratch
- Adding token or JWT authentication to Django endpoints
- Fixing N+1 query problems in DRF list views
- Writing serializers with separate read and write representations
- Setting up rate limiting for anonymous and authenticated users
Example Workflow
User asks: Set up a new Django REST API project with authentication and pagination
- 1
Create a virtual environment and install django and djangorestframework
- 2
Run django-admin startproject and manage.py startapp to scaffold the project
- 3
Configure REST_FRAMEWORK settings with IsAuthenticated, JSONRenderer, and LimitOffsetPagination
- 4
Create a ModelSerializer and ModelViewSet for the target resource
- 5
Register the viewset with a DRF router and include the URLs in the main urls.py
A working Django REST API with authenticated endpoints, paginated list views, and standard CRUD routes
Installation
clawhub install pradeepcep/drfRun the CLI command, or paste the prompt into Claude Code, Cursor, Codex or whichever coding agent you use.