Metadata-Version: 1.1
Name: pip-test-swagger
Version: 0.1.3
Summary: Django REST Framework + Swagger
Home-page: https://github.com/koyouhun/drf_swagger
Author: YouHyeon Ko
Author-email: koyouhun@gmail.com
License: BSD
Description: # DRF Swagger
        #### Code Based API document builder
        
        # Overview
        - Django Rest Framework (DRF)
        - Code Based (Serializer to Docs)
        - Swagger UI (https://swagger.io/swagger-ui/)
        
        
        # Example
        ```python
        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'
                )
        ```
        ![example-img]
        
        
        # Install
        
        # Quick Start
        
        # Warning
        - For security, override SwaggerView and add login
        - Will Make login/security setting someday...
        
        [example-img]: https://github.com/koyouhun/drf_swagger/blob/master/img/web.png?raw=true
        
Keywords: django,swagger,api,documentation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.7
