Warum wird diese django-rest-swagger-API-Dokumentation nicht korrekt angezeigt / funktioniert?

8

Ich habe eine Django-API erstellt, die bei Angabe einer E-Mail-Adresse über POST mit einem booleschen Wert antwortet, der angibt, ob die E-Mail-Adresse in meiner Datenbank bereits existiert:

%Vor%

Nun möchte ich das Django-Rest-Swagger -Paket verwenden um automatisch Dokumentation für diese API zu generieren. Ich habe das Paket installiert und die obigen Kommentare in die Anführungszeichen eingefügt. Wenn ich mir die Dokumentation von django-rest-swagger für diese API ansehe, sehe ich das Bild unten.

Wenn ich jedoch auf die Schaltfläche Try it out! klicke, erhalte ich den unten gezeigten Fehler. Insbesondere gibt es mir nie die Möglichkeit, das E-Mail-Argument einzugeben, das es per POST senden soll.

Warum erstellt das Django-Swagger-Package keine Dokumente, mit denen ich das Argument "E-Mail" per POST richtig schreiben kann? Wie mache ich das?

    
Saqib Ali 09.09.2014, 20:20
quelle

2 Antworten

11

Ich habe dies mit cigar_example getestet, das von django-rest-swagger erstellt wurde, und in diesem Beispiel haben sie einen benutzerdefinierte Ansicht , die keine Eingabeparameter darstellt

Zuletzt schaue ich in den Quellcode und fand heraus, dass django-rest-swagger get_serializer_class benötigt, um body-Parameter zu erstellen

so hat es mit dem folgenden Code funktioniert

%Vor%

und IsEmailTakenSerializer

%Vor%     
Venkatesh Bachu 12.09.2014, 07:42
quelle
1

django-rest-swagger versucht, eine POST-Anfrage ohne Daten zu senden.

Zuerst müssen Sie Ihre Ansicht folgendermaßen korrigieren:

%Vor%

Wenn Sie dies versuchen, sollten Sie jetzt Ihre nette Fehlermeldung sehen.

Der nächste Schritt ist, django-rest-swagger docs zu betrachten, um herauszufinden, was zu tun ist, dass es ein HTML-Formularfeld direkt über der Schaltfläche "Ausprobieren" rendert.

    
Norman8054 10.09.2014 09:27
quelle