Perché questa documentazione dell'API django-rest-swagger non viene visualizzata/funziona correttamente?

Question

Ho costruito un API Django che quando dato un indirizzo e-mail tramite il POST risponderà con un valore booleano che indica il tempo o non quell'indirizzo email già esiste nel mio database:

class isEmailTaken(views.APIView): 
    permission_classes = [permissions.AllowAny,] 

    def post(self, request, *args, **kwargs): 
     try: 
      email = request.DATA['email'] 
     except KeyError: 
      return HttpResponse(
       'An email was not given with this request.', 
       status=status.HTTP_400_BAD_REQUEST, 
      ) 
     return HttpResponse(
      json.dumps(
       User.objects.filter(email=email), 
       content_type="application/json", 
       status=status.HTTP_200_OK, 
      ) 
     ) 

ora vorrei utilizzare il django-rest-swagger per generare automaticamente la documentazione per questa API. Ho installato il pacchetto e inserito i commenti che vedi sopra tra le virgolette. Quando guardo la documentazione prodotta da django-rest-swagger per questa API, vedo l'immagine qui sotto.

Tuttavia, quando si fa clic sul pulsante Try it out!, ottengo l'errore mostrato di seguito. In particolare, non mi dà mai la possibilità di inserire l'argomento email che dovrebbe inviare tramite POST.

Perché l'Django-Swagger-Package creare documenti che mi permettono di correttamente l'argomento "e-mail" tramite POST? Come faccio a fare questo lavoro?

Answer 1

ho provato questo con cigar_example che è fatto da django-riposo-spavalderia e in questo esempio hanno scritto una custom view che non è anche il rendering ingresso Parametri

Infine guardo in codice sorgente e ha scoperto che Django-resto- spavalderia ha bisogno di costruire get_serializer_class parametri corporei

quindi ha funzionato con il seguente codice

class isEmailTaken(views.APIView): 
    permission_classes = [permissions.AllowAny,] 
    serializer_class = IsEmailTakenSerializer 

def get_serializer_class(self): 
    return self.serializer_class 

def post(self, request, *args, **kwargs): 
    try: 
     email = request.DATA['email'] 
    except KeyError: 
     return HttpResponse(
      'An email was not given with this request.', 
      status=status.HTTP_400_BAD_REQUEST, 
     ) 
    return HttpResponse(
     json.dumps(
      User.objects.filter(email=email), 
      content_type="application/json", 
      status=status.HTTP_200_OK, 
     ) 
     ) 

e IsEmailTakenSerializer

from rest_framework import serializers 
class IsEmailTakenSerializer(serializers.Serializer): 
    email = serializers.EmailField() 

Answer 2

django-rest-swagger tenta di inviare una richiesta POST senza alcuni dati.

Per prima cosa devi correggere la visualizzazione in questo modo:

from rest_framework import status 
from django.http import HttpResponse 
import json 

def post(self, request, *args, **kwargs): 
    try: 
     email = request.DATA['email'] 
    except KeyError: 
     return HttpResponse(
      'An email was not given with this request.', 
      status=status.HTTP_400_BAD_REQUEST, 
     ) 
    return HttpResponse(
     json.dumps(
      User.objects.filter(email=email), 
      content_type="application/json", 
      status=status.HTTP_200_OK, 
     ) 
    ) 

Se si tenta questo, si dovrebbe vedere il messaggio di errore bello ora.

Il passaggio successivo consiste nell'esaminare i documenti di django-rest-swagger per scoprire che cosa deve eseguire il rendering di un campo di modulo html sopra il pulsante "Provalo".