Wie dokumentiert man funktionsbasierte Sichtenparameter?

Question

Ich entwickle eine REST API mit Django 1.11 und Django REST Framework 3.7. Ich habe Django REST Swagger 2.1 installiert, um die Dokumentation zu generieren.

Ich verwende eine funktionsbasierte Ansicht wie folgt aus:

from rest_framework.decorators import api_view, permission_classes 

@api_view(['POST']) 
@permission_classes((permissions.AllowAny,)) 
def jwt_auth(request, provider, format=None): 
    """ 
    View description here 
    """ 
    pass 

Wie Sie sehen können, meine Ansicht von Swagger erkannt wird und es hat die richtige Beschreibung: "Beschreibung Aussicht hier ".

jedoch:

• Sie können die "Beschreibung" Spalte sehen ist leer für die provider URL-Parameter.
• Die POST-Parameter sind nicht (natürlich, weil es keine Möglichkeit gibt für Prahlerei, sie zu kennen) dokumentiert

Wie kann ich die Dokumentation für die URL und POST-Parameter einer Funktion basierte Ansicht schreiben, als auch wie die Antworten?

Ich versuchte YAML Docstrings, aber es scheint, dass es für die alte Version (0.3.x) ist und es nicht mit Version 2.x funktioniert.

Answer 1

Nach diesem github issue, es scheint, dass es für die methodenbasierte Ansichten nicht möglich ist, wie Sie angegeben haben.

Aber ich denke, this link kann Ihnen helfen.