Как именно мы реализуем документы о чванстве для django APIView - PullRequest
0 голосов
/ 24 февраля 2019

Итак, у меня есть конечная точка GenericAPIView django, для которой я хочу добавить документацию swagger.Я искал всю документацию о том, как сделать django-rest-swagger, но, похоже, я не очень понимаю их.Ниже приведены мои файлы.

views.py

class SignUpAPIView(GenericAPIView):

    """

    get: Not Available

    post: This endpoint presents Sign Up facility for the user.

    Try it urself by sending a request in the below form


    """
    permission_classes = [AllowAny]
    serializer_class = SignupSerializer

    def get(self, request, format=None):
        return Response("Only POST Method is allowed")

    def post(self,request,format=None):
        serializer = SignupSerializer(data=request.data)
        data = request.data
        if serializer.is_valid():
            valid_data=serializer.data
            print(valid_data)
        return Response("Success", status=status.HTTP_200_OK)

serializer.py

class SignupSerializer(serializers.Serializer):

    name = serializers.CharField(required=True, max_length=150)
    username = serializers.CharField(required=True, max_length=150)
    mobileNumber = serializers.CharField(required=True, max_length=10)
    email = serializers.CharField(required=True, max_length=150)
    password = serializers.CharField(required=True, max_length=150)

Этотекущий пользовательский интерфейс Swagger Doc, который визуализируется.

enter image description here

Как сделать значение в примере в описании для чего-то из приведенной ниже формы?

{
    "user":{
        "name":"string",
        "username":"string",
        "mobileNumber":"string",
        "email":"string",
        "password":"string"
    }
}

Кроме того, если бы кто-то мог объяснить, как именно мы можем создать хорошую документацию, используя чванство, это было бы очень полезно.Краткое объяснение того, как именно работает чванство, было бы полезно.Заранее спасибо.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...