README

A Kirby plugin that that provides populated fields via REST API. This is especially helpful for using Kirby as headless CMS with Static Site Generation at build time where you would like to get a page along with all its nested resources (files, pages, etc.) within one request.

Installation

Manual

Download and copy this repository to /site/plugins/kirby-populated-fields-api of your Kirby installation.

Composer

composer require pulsundzeit/kirby-populated-fields-api

Usage

The plugin exposes an custom endpoint at /api/populated that acts as a drop in replacement for default API.

Examples:

api/populated/pages/:id (https://getkirby.com/docs/reference/api/pages)
api/populated/site (https://getkirby.com/docs/reference/api/site)
api/populated/users/:id (https://getkirby.com/docs/reference/api/users)

Official Kirby 3 API docs

Authentication

Like the default Kirby API requests must be authenticated.

pulsundzeit / kirby-populated-fields-api

Maintainers

Details