Wagtail API v2 설정 가이드¶

# settings.py

INSTALLED_APPS = [
    ...

    'wagtail.api.v2',

    ...
]

from rest_framework.renderers import JSONRenderer

# ...

class CustomPagesAPIViewSet(PagesAPIViewSet):
    renderer_classes = [JSONRenderer]
    name = "pages"

api_router.register_endpoint("pages", CustomPagesAPIViewSet)

from rest_framework.renderers import JSONRenderer

# ...

class PostPagesAPIViewSet(PagesAPIViewSet):
    model = models.BlogPage


api_router.register_endpoint("posts", PostPagesAPIViewSet)

# api.py

from wagtail.api.v2.views import PagesAPIViewSet
from wagtail.api.v2.router import WagtailAPIRouter
from wagtail.images.api.v2.views import ImagesAPIViewSet
from wagtail.documents.api.v2.views import DocumentsAPIViewSet

# 라우터를 만듭니다. "wagtailapi"는 URL 네임스페이스입니다.
api_router = WagtailAPIRouter('wagtailapi')

# "register_endpoint" 메서드를 사용하여 세 개의 엔드포인트를 추가합니다.
# 첫 번째 매개변수는 엔드포인트의 이름(예: 페이지, 이미지)입니다. 이것은
# 엔드포인트의 URL에 사용됩니다.
# 두 번째 매개변수는 요청을 처리하는 엔드포인트 클래스입니다.
api_router.register_endpoint('pages', PagesAPIViewSet)
api_router.register_endpoint('images', ImagesAPIViewSet)
api_router.register_endpoint('documents', DocumentsAPIViewSet)

# urls.py

from .api import api_router

urlpatterns = [
    ...

    path('api/v2/', api_router.urls),

    ...

    # api_router 라인이 기본 Wagtail 페이지 제공 경로 위에 오도록 합니다.
    re_path(r'^', include(wagtail_urls)),
]

# blog/models.py

from wagtail.api import APIField

class BlogPageAuthor(Orderable):
    page = models.ForeignKey('blog.BlogPage', on_delete=models.CASCADE, related_name='authors')
    name = models.CharField(max_length=255)

    api_fields = [
        APIField('name'),
    ]


class BlogPage(Page):
    published_date = models.DateTimeField()
    body = RichTextField()
    feed_image = models.ForeignKey('wagtailimages.Image', on_delete=models.SET_NULL, null=True, ...)
    private_field = models.CharField(max_length=255)

    # API를 통해 필드 내보내기
    api_fields = [
        APIField('published_date'),
        APIField('body'),
        APIField('feed_image'),
        APIField('authors'),  # 이렇게 하면 관련 BlogPageAuthor 객체가 API 응답에 중첩됩니다.
    ]

from wagtail.api import APIField

class FormPage(AbstractEmailForm):
    #...
    api_fields = [
        APIField('form_fields'),
    ]

from rest_framework.fields import DateField

class BlogPage(Page):
    ...

    api_fields = [
        # published_date 필드의 형식을 "Thursday 06 April 2017"로 변경
        APIField('published_date', serializer=DateField(format='%A %d %B %Y')),
        ...
    ]

from rest_framework.fields import DateField

class BlogPage(Page):
    ...

    api_fields = [
        # ISO8601 형식의 날짜(기본값)
        APIField('published_date'),

        # 다른 형식의 별도 published_date_display 필드
        APIField('published_date_display', serializer=DateField(format='%A %d %B %Y', source='published_date')),
        ...
    ]

from rest_framework.fields import CharField
from wagtail.rich_text import expand_db_html


class RichTextSerializer(CharField):
    def to_representation(self, instance):
        representation = super().to_representation(instance)
        return expand_db_html(representation)

APIField('body', serializer=RichTextSerializer()),

from wagtail.api import APIField
from wagtail.images.api.fields import ImageRenditionField

class BlogPage(Page):
    ...

    api_fields = [
        # 원본 이미지에 대한 정보(예: 제목)를 API에 추가합니다.
        APIField('feed_image'),

        # 렌더링된 이미지 썸네일의 URL을 API에 추가합니다.
        APIField('feed_image_thumbnail', serializer=ImageRenditionField('fill-100x100', source='feed_image')),
        ...
    ]

# api.py

from rest_framework.permissions import IsAuthenticated

# ...

class CustomPagesAPIViewSet(PagesAPIViewSet):
    name = "pages"
    permission_classes = (IsAuthenticated,)


api_router.register_endpoint("pages", CustomPagesAPIViewSet)

# settings.py

INSTALLED_APPS = [
    ...

    'rest_framework.authtoken',

    ...
]

...

REST_FRAMEWORK = {
    "DEFAULT_AUTHENTICATION_CLASSES": [
        "rest_framework.authentication.TokenAuthentication"
    ],
}