New Wagtail Course! 🥳 The Ultimate Wagtail Developers Course

Tutorial Wagtail Version: 2.x

Headless CMS: Serializing Foreign Keys

Wagtail Page's can have ForeignKeys to other pages. In this tutorial you'll learn how to return better ForeignKey data in your Headless Wagtail CMS website.

``` from rest_framework.fields import Field from wagtail.core.models import Page class BannerCTASerializer(Field): def to_representation(self, page): return { 'id': page.id, 'title': page.title, 'first_published_at': page.first_published_at, 'owner': page.owner.username, 'slug': page.slug, 'url': page.url, } class HomePage(Page): # .. other fields banner_cta = models.ForeignKey( "wagtailcore.Page", null=True, blank=True, on_delete=models.SET_NULL, related_name="+", ) # Your api fields api_fields = [ APIField("banner_cta", serializer=BannerCTASerializer()), ] ```
View On GitHub

Related tutorials

Headless CMS: Serializing RichText Blocks

Posted on

Wagtail stores RichText (WYSIWYG) data as HTML-like code, but it's not perfect HTML. In this video we'll explore how to serialize Wagtail's RichText data into proper HTML.

View lesson, Headless CMS: Serializing RichText Blocks

Headless CMS: Serializing Child Pages (and QuerySets)

Posted on

In this video we'll add all the blog pages to the blog listing page API response. This can be very helpful for Listing-style pages in your Headless Wagtail website.

View lesson, Headless CMS: Serializing Child Pages (and QuerySets)

Headless CMS: Image Rendition Field

Posted on

In the previous lesson we created a custom Django Rest Framework Serializer to output JSONified image data in the Wagtail v2 API, including the URL, title, height and width. In this tutorial I'll show you how to to do the same thing but in one line of code using a built in Wagtail class.

View lesson, Headless CMS: Image Rendition Field

Headless CMS: Custom Page Properties

Posted on

If you want to add data custom data (or a function output) to your headless Wagtail API, you can use a @property. In this tutorial I'll show you how easy it can be!

View lesson, Headless CMS: Custom Page Properties

The Ultimate Wagtail Developers Course

This course covers everything from basic installation to advanced features like custom blocks and API integration, it's perfect for developers looking to enhance their skills with this powerful CMS.

Get started Learn more
Ultimate Wagtail Developers Course Logo