DRF Swagger
Code Based API document builder
Overview
Example
from django.http import HttpResponse
from django.contrib.auth.models import User
from rest_framework import viewsets, serializers
from drf_swagger import drf_request, drf_response
class ViewSetTest (viewsets .ViewSet ):
lookup_field = ' view_set'
@drf_request (RootSerializer)
@drf_response (RootSerializer)
def update (self , request , view_set ):
"""
summary: test summary
parameters:
- name: test_param
in: query
type: string
description: Only 'name, in, type' is required
example: test example
required: true
"""
return HttpResponse(" !@3123" )
class RootSerializer (serializers .ModelSerializer ):
id = serializers.CharField(
help_text = ' user pk: 46887' ,
required = True
)
class Meta :
model = User
fields = (
' email' ,
' id'
)
Install
Quick Start
Warning
For security, override SwaggerView and add login
Will Make login/security setting someday...