Example GET Endpoint

from rest_framework.views import APIView
from rest_framework.response import Response
from pydantic import BaseModel as Schema
import datetime


class ArticleDetailSchema(Schema):
    created : datetime.datetime
    title : str
    author : str
    content : str


class RandomArticleAPI(APIView):
    """Return a random article from the Blog"""

    response_schema = ArticleDetailSchema

    def get(self, request):
        ...
        return Response({})

Generated documentation

Example POST Endpoint

from rest_framework.views import APIView
from rest_framework.response import Response
from pydantic import BaseModel as Schema, Field
import datetime


class ArticleDetailSchema(Schema):
    created : datetime.datetime
    title : str
    author : str
    content : str

class ArticleCreateSchema(Schema):
    """POST schema for blog article creation"""
    title : str = Field(description="Title of Blog article")
    content : str = Field(description="Blog article content")


class ArticleCreateAPI(APIView):

    request_schema = ArticleCreateSchema
    response_schema = ArticleDetailSchema

    def post(self, request):
        ...
        return Response({})

Generated documentation

For more involved examples, check out the example project and the API documentation generated from that project.

Documentation & Support

• Read the full documentation for Djagger: https://djagger-docs.netlify.app

• This project is in continuous development. If you have any questions or would like to contribute, please email royhung@protonmail.com

• If you want to support this project, do give it a ⭐ on github!