[Django Install] 5. Django REST API Framework

[Django REST Framework ]


pip install djangorestframework
pip install markdown                     # Markdown support for the browsable API.
pip install django-filter                  # Filtering support
pip install django-cors-headers

settings.py 수정

INSTALLED_APPS = [
    ...
    'rest_framework',
    'django_filters',
    'corsheaders',
]

MIDDLEWARE = [

    'django.middleware.security.SecurityMiddleware',

    'django.contrib.sessions.middleware.SessionMiddleware',

    'django.middleware.common.CommonMiddleware',

    'django.middleware.csrf.CsrfViewMiddleware',

    'django.contrib.auth.middleware.AuthenticationMiddleware',

    'django.contrib.messages.middleware.MessageMiddleware',

    'django.middleware.clickjacking.XFrameOptionsMiddleware',

    'corsheaders.middleware.CorsMiddleware',  # corsheaders 추가

]


CORS_ORIGIN_ALLOW_ALL = True 

CORS_ALLOW_CREDENTIALS = True

CORS_ORIGIN_WHITELIST = [

    'http://192.168.56.1:3000',

] 

CORS_ORIGIN_REGEX_WHITELIST = [

    'http://192.168.56.1:3000',

]




[api App 생성]

cd

cd [project]

python manage.py startapp api

project
    api
        __init__.py
        migrations
        templates (신규생성 필요)
            api (신규생성 필요)
                *.html (신규생성 필요)
        static (신규생성 필요)
            api (신규생성 필요)
                css (신규생성 필요)
                images (신규생성 필요)
                js (신규생성 필요)
                sass (신규생성 필요)
        admin.py
        apps.py
        models.py
        tests.py
        views.py


project/project/settings.py에 아래 내용 추가

INSTALLED_APPS = [
   ...
    'api',
   ...
]


[Django REST Framework Swagger Install]

pip install -U drf-yasg

INSTALLED_APPS = [ 

   ... 

   'drf_yasg', 

   ... 

]


project's urls.py

from django.contrib import admin

from django.urls import path, include


from django.conf import settings

from django.conf.urls.static import static


urlpatterns = [

    path('admin/', admin.site.urls),

    path('api/', include('api.urls')),

]


if settings.DEBUG is True:

    urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)


app's yasg.py

# from django.conf.urls import url

from django.urls import path, include

from rest_framework import permissions

from drf_yasg.views import get_schema_view

from drf_yasg import openapi


schema_view = get_schema_view(

   openapi.Info(

      title="aiPass API",

      default_version='v1',

      description="aiPass API description",

      terms_of_service="https://www.google.com/policies/terms/",

      contact=openapi.Contact(email="prefity@gmail.com"),

      license=openapi.License(name="BSD License"),

   ),

   validators=['flex'],

   public=True,

   permission_classes=(permissions.AllowAny,),

#    patterns=schema_url_patterns,

)


app's urls.py

from django.urls import include, path

from rest_framework import routers

from django.views.decorators.csrf import csrf_exempt

from django.views.generic import TemplateView

from . import views, yasg


router = routers.DefaultRouter()

# router.register(r'users', views.UserViewSet, basename='user')


# Wire up our API using automatic URL routing.

# Additionally, we include login URLs for the browsable API.

urlpatterns = [

    path('', include(router.urls)),

    path('swagger<str:format>', yasg.schema_view.without_ui(cache_timeout=0), name='schema-json'),

    path('swagger/', yasg.schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),

    path('docs/', yasg.schema_view.with_ui('redoc', cache_timeout=0), name='schema-redic'),

]


# api 브라우저 확인

http://localhost:8000/api/swagger/



[Django REST Framework Token Install]

INSTALLED_APPS = [ 

   ... 

   'rest_framework.authtoken', 

   ... 

]


python manage.py migrate

project/app/models.py

from django.db.models.signals import post_save

from django.dispatch import receiver

from django.conf import settings

from rest_framework.authtoken.models import Token


@receiver(post_save, sender=settings.AUTH_USER_MODEL)

def create_auth_token(sender, instance=None, created=False, **kwargs):

    if created:

        Token.objects.create(user=instance)


project/app/views.py

from rest_framework.authtoken.views import ObtainAuthToken

from rest_framework.authtoken.models import Token

from rest_framework.response import Response


class ApiAuthToken(ObtainAuthToken):


    def post(self, request, *args, **kwargs):

        serializer = self.serializer_class(data=request.data,

                                           context={'request': request})

        serializer.is_valid(raise_exception=True)

        user = serializer.validated_data['user']

        token, created = Token.objects.get_or_create(user=user)

        return Response({

            'token': token.key,

            'username': user.username,

            'email': user.email

        })


project/app/urls.py

from django.urls import include, path

from rest_framework import routers

from django.views.decorators.csrf import csrf_exempt

from django.views.generic import TemplateView

from . import views, yasg


router = routers.DefaultRouter()

router.register(r'lottos', views.LottoViewSet, basename='lotto')


# Wire up our API using automatic URL routing.

# Additionally, we include login URLs for the browsable API.

urlpatterns = [

    path('', include(router.urls)),

    path('api_token_auth/', views.ApiAuthToken.as_view()),

    path('swagger<str:format>', yasg.schema_view.without_ui(cache_timeout=0), name='schema-json'),

    path('swagger/', yasg.schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),

    path('docs/', yasg.schema_view.with_ui('redoc', cache_timeout=0), name='schema-redic'),

]


admin 화면에서 사용자 생성 시 token이 잘 생성되는지 확인.



[api models 생성]

project/app/models.py

from django.db import models

from django.shortcuts import get_object_or_404

from django.utils import timezone

from django.contrib.auth.models import User


from django.utils.html import strip_tags


from django.db.models.signals import post_save

from django.dispatch import receiver

from django.conf import settings


from datetime import date


import logging


logger = logging.getLogger('api')


# Schema


class Lotto(models.Model):

    round           = models.IntegerField(default=0)

    date            = models.DateField()

    lotto1          = models.IntegerField(default=0)

    lotto2          = models.IntegerField(default=0)

    lotto3          = models.IntegerField(default=0)

    lotto4          = models.IntegerField(default=0)

    lotto5          = models.IntegerField(default=0)

    lotto6          = models.IntegerField(default=0)

    lotto7          = models.IntegerField(default=0)

    lotto1_winner   = models.IntegerField(default=0)

    lotto2_winner   = models.IntegerField(default=0)

    lotto3_winner   = models.IntegerField(default=0)

    lotto4_winner   = models.IntegerField(default=0)

    lotto5_winner   = models.IntegerField(default=0)

    lotto1_winning  = models.IntegerField(default=0)

    lotto2_winning  = models.IntegerField(default=0)

    lotto3_winning  = models.IntegerField(default=0)

    lotto4_winning  = models.IntegerField(default=0)

    lotto5_winning  = models.IntegerField(default=0)


python manage.py makemigrations
python manage.py migrate


[api admin 적용]

project/app/admin.py 에서 모델을 어드민에 등록

from django.contrib import admin

from django.utils.safestring import mark_safe

from django.contrib.auth.models import User

from django.contrib.auth.admin import UserAdmin

from . import models



class LottoAdmin(admin.ModelAdmin):

    list_display = ('id', 'round', 'date', 'lotto1', 'lotto2', 'lotto3', 'lotto4', 'lotto5', 'lotto6', 'lotto7')

    list_display_links = ['round']

    list_per_page = 10


# unregister old user admin

admin.site.unregister(User)

# register new user admin

admin.site.register(User, UserAdmin)

admin.site.register(models.Lotto, LottoAdmin)



[api serializers 적용]

project/app/serializers.py

from django.contrib.auth.models import User, Group

from django.contrib.auth import authenticate

from django.conf import settings

from rest_framework import pagination

from rest_framework.response import Response

from rest_framework import serializers


from . import models


import logging

logger = logging.getLogger('api')



# Serializer


class LottoSerializer(serializers.ModelSerializer):

    class Meta:

        model = models.Lotto

        fields = '__all__'



[api views 작성]

project/app/views.py

class LottoViewSet(viewsets.ModelViewSet):

    

    authentication_classes = [TokenAuthentication]

    permission_classes = [IsAuthenticated]

    renderer_classes = [JSONRenderer]


    queryset = models.Lotto.objects.all()

    serializer_class = serializers.LottoSerializer

    filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]

    filterset_fields = '__all__'

    search_fields = ['round']

    ordering_fields = '__all__'

    ordering = ['date']


------------------


from rest_framework import viewsets

from rest_framework.response import Response

from rest_framework.decorators import action, api_view, permission_classes


class RaViewSet(viewsets.ViewSet):

    def list(self, request):

        pid = request.query_params.get('pid', None)

        return Response("list" + pid)


    @action(detail=True, methods=['get'])

    def ratest(self, request, pk=None):

        pid = request.query_params.get('pid', None)

        return Response("list" + pid)




[api urls 작성]

project/app/urls.py

from django.urls import include, path

from rest_framework import routers

from django.views.decorators.csrf import csrf_exempt

from django.views.generic import TemplateView

from . import views, yasg


router = routers.DefaultRouter()

router.register(r'lottos', views.LottoViewSet, basename='lotto')


# Wire up our API using automatic URL routing.

# Additionally, we include login URLs for the browsable API.

urlpatterns = [

    path('', include(router.urls)),

    path('swagger<str:format>', yasg.schema_view.without_ui(cache_timeout=0), name='schema-json'),

    path('swagger/', yasg.schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),

    path('docs/', yasg.schema_view.with_ui('redoc', cache_timeout=0), name='schema-redic'),

]



댓글

댓글 쓰기

이 블로그의 인기 게시물

[Django Install] 9.1 sc제일은행 nginx-django 연결

[Django 설치] Django는 이미 설치된 것으로 가정하고 진행. 프로젝트명 : sc 프로젝트 디렉토리 : /datanode/datashare/sc [Django static 파일 마이그레이션] nginx에서 사용할 static 파일을 만들어 준다. python manage.py collectstatic  (static_root만 영향을 준다.) STATIC_ROOT   =   os . path . join ( BASE_DIR ,   "staticfiles/" ) 에 설정된  staticfiles  디렉토리 하위에 app별 폴더가 만들어진다. (app의 static 폴더의 images, js, css 파일에 변경이 있으면 실행이 필요하다) MEDIA_ROOT = os.path.join(BASE_DIR, 'mediafiles') 에 설정된 디렉토리에는 첨부파일이나 업로드 이미지 파일이 만들어진다. (위 명령어와 관련이 없으며, 관리자나 사용자가 업로드한 파일들이 저장된다.) [uwsgi 설치] 파이썬 가상화 환경에 로그인한 후 실행 pip install uwsgi [Nginx 설치] sudo apt-get install nginx 설치 후 자동적으로 Nginx가 Start 된다. 프로세스 시작 : sudo service nginx start 프로세스 종료 : sudo service nginx stop 프로세스 재시작 : sudo service nginx restart 프로세스 상태 : sudo service nginx status [ Nginx - Django 연동 ] /datanode/datashare/web/nginx/nginx.conf 파일수정 (아래 내용으로 수정) # the upstream component nginx needs to connect to      upstream django {         server unix:///datanode/datashare/web/sc/sc.sock;     }     
자세한 내용 보기

[Django APP] django-widget-tweaks

[설치] pip install django-widget-tweaks [설정] INSTALLED_APPS = [      ...      'widget_tweaks',      ... ] [사용법] In template {% load widget_tweaks %} <!-- change input type (e.g. to HTML5) --> {% render_field form.search_query type="search" %} <!-- add/change several attributes --> {% render_field form.text rows="20" cols="20" title="Hello, world!" %} <!-- append to an attribute --> {% render_field form.title class+="css_class_1 css_class_2" %} <!-- template variables can be used as attribute values --> {% render_field form.text placeholder=form.text.label %} {% render_field %} 태그로 렌더링 된 필드의 경우 WIDGET_ERROR_CLASS 및 WIDGET_REQUIRED_CLASS 템플릿 변수를 사용하여 오류 클래스 및 필수 필드 클래스를 설정할 수 있습니다. {% with WIDGET_ERROR_CLASS = 'my_error'WIDGET_REQUIRED_CLASS = 'my_required'%}     {% render_field form.field1 %}     {% render_field form.field2 %}
자세한 내용 보기

[Django App] django-user-agents

[설치] pip install pyyaml ua-parser user-agents pip install django-user-agents [설정] settings.py 수정 INSTALLED_APPS = (     # Other apps...     'django_user_agents', ) MIDDLEWARE = (     # other middlewares...     'django_user_agents.middleware.UserAgentMiddleware', ) #  django-user-agents Settings # Cache backend is optional, but recommended to speed up user agent parsing # CACHES = { #    'default': { #        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', #        'LOCATION': '127.0.0.1:11211', #    } # } # Name of cache backend to cache user agents. If it not specified default # cache alias will be used. Set to `None` to disable caching. USER_AGENTS_CACHE = 'default' [소스 활용] def my_view(request):     # Let's assume that the visitor uses an iPhone...     request.user_agent.is_mobile # returns True     request.user_agent.
자세한 내용 보기