Getting Started
Installation
Install using pip
pip install djagger
Add djagger to your INSTALLED_APPS setting in your Django project like this:
INSTALLED_APPS = [
...
'djagger',
]
Include the djagger URLconf in your project urls.py like this if you want to use the built-in document views.
urlpatterns = [
...
path('djagger/', include('djagger.urls')),
]
Note
To see the generated documentation, use the route /djagger/api/docs. Djagger uses Redoc as the default client generator.
To get the generated JSON schema file, use the route /djagger/schema.json.
The path djagger/ is not compulsory when setting this configuration. Replace djagger/ with your preferred route prefix. For customized control over the documentation views, free to remove djagger.urls and write your own views. The routes provided here are for you to get started quickly.
Package Overview
Djagger is a pydantic-based Django package that automates the documentation of APIs. The documentation generated is OpenAPI 3 compliant. Djagger seeks to simplify the documentation process while providing a high degree of customization for the generated documentation, all without adding too much bloat to your existing codebase.
Features
Schema Driven Development - Use pydantic to generate schema objects to document your Views. Your schemas can in turn be used to validate your requests and responses to ensure that they are consistent with your documentation.
Quickstart
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({})
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({})