Django Rest Framework용 API 문서 생성

5834 단어 pythondjangoapidocs
이 블로그에서는 2분 만에 Django API 문서를 생성하는 방법을 보여 드리겠습니다. 시작하자,

REST API용 문서를 생성하는 데 사용할 수 있는 도구가 많이 있지만 저는 간단하고 명료한 것을 선호합니다.

이 예에서는 다음 설정으로 snippet 모델을 만들었습니다.
models.py 파일,

from django.db import models

class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')

serializer.py 파일,

from rest_framework import serializers
from .models import Snippet

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = '__all__'

views.py 파일,

from rest_framework import viewsets
from .models import Snippet
from .serializer import SnippetSerializer

class SnippetViewSet(viewsets.ModelViewSet):
    """
    This viewset automatically provides `list`, `create`, `retrieve`,
    `update` and `destroy` actions.
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer



API 문서에 대한 URL 끝점을 제공하겠습니다.

from .views import SnippetViewSet
from django.urls import include, path
from rest_framework.routers import DefaultRouter
from rest_framework.documentation import include_docs_urls

router = DefaultRouter()
router.register(r'snippet', SnippetViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
    path('docs/', include_docs_urls(title='Snippet API'))
]


Note that the doc-strings provided in the views.py file will be used for our documentation so please provide as much information as you can.



이제 API 문서를 http://localhost:8000/docs 에서 찾을 수 있습니다.

즐거운 코딩!

참조


  • Build a RESTAPI using nested serializers in Django-Rest-Framework: medium
  • 좋은 웹페이지 즐겨찾기