PHPackages                             bnomei/kirby-api-pages - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. bnomei/kirby-api-pages

ActiveKirby-plugin[HTTP & Networking](/categories/http)

bnomei/kirby-api-pages
======================

Virtual Pages from APIs

5.1.1(9mo ago)1410MITPHPPHP >=8.2CI failing

Since Feb 19Pushed 9mo ago2 watchersCompare

[ Source](https://github.com/bnomei/kirby-api-pages)[ Packagist](https://packagist.org/packages/bnomei/kirby-api-pages)[ RSS](/packages/bnomei-kirby-api-pages/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (6)Versions (5)Used By (0)

Kirby API-Pages
===============

[](#kirby-api-pages)

[![Kirby 5](https://camo.githubusercontent.com/b1a1b2ccd58e96259a9722c2489d91f40378c01b6c4c3e9fd27ed1d12c269d7c/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f4b697262792f353f636f6c6f723d454343373438)](https://getkirby.com)[![PHP 8.2](https://camo.githubusercontent.com/fd050028b4459f3f6e4db5703412957375ceb180d27951213d421eb2a23c8c8e/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f5048502f382e323f636f6c6f723d3445354239332669636f6e3d706870266c6162656c)](https://camo.githubusercontent.com/fd050028b4459f3f6e4db5703412957375ceb180d27951213d421eb2a23c8c8e/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f5048502f382e323f636f6c6f723d3445354239332669636f6e3d706870266c6162656c)[![Release](https://camo.githubusercontent.com/98b7516b02fd4bfd6433c5ed1c7353d281e24a3214ecd7d316dca05d206671e6/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f762f626e6f6d65692f6b697262792d6170692d70616765733f636f6c6f723d6165383166662669636f6e3d676974687562266c6162656c)](https://camo.githubusercontent.com/98b7516b02fd4bfd6433c5ed1c7353d281e24a3214ecd7d316dca05d206671e6/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f762f626e6f6d65692f6b697262792d6170692d70616765733f636f6c6f723d6165383166662669636f6e3d676974687562266c6162656c)[![Downloads](https://camo.githubusercontent.com/c72ec0f8a1c98e6ab0a8445f904d94d6bbafc3c4eccd0d161398d3c68b3b9156/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f64742f626e6f6d65692f6b697262792d6170692d70616765733f636f6c6f723d3237323832322669636f6e3d676974687562266c6162656c)](https://camo.githubusercontent.com/c72ec0f8a1c98e6ab0a8445f904d94d6bbafc3c4eccd0d161398d3c68b3b9156/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f64742f626e6f6d65692f6b697262792d6170692d70616765733f636f6c6f723d3237323832322669636f6e3d676974687562266c6162656c)[![Coverage](https://camo.githubusercontent.com/df83cee8f58102b98d3a077d6c5863c111956db7f6641360a3cd4fe8e5fa7f0e/68747470733a2f2f666c61742e62616467656e2e6e65742f636f6465636c696d6174652f636f7665726167652f626e6f6d65692f6b697262792d6170692d70616765733f69636f6e3d636f6465636c696d617465266c6162656c)](https://codeclimate.com/github/bnomei/kirby-api-pages)[![Maintainability](https://camo.githubusercontent.com/230eff4ac683052b04039bdb76078a47b2eb22df0d41e4622e03a071a16037b9/68747470733a2f2f666c61742e62616467656e2e6e65742f636f6465636c696d6174652f6d61696e7461696e6162696c6974792f626e6f6d65692f6b697262792d6170692d70616765733f69636f6e3d636f6465636c696d617465266c6162656c)](https://codeclimate.com/github/bnomei/kirby-api-pages/issues)[![Discord](https://camo.githubusercontent.com/36eaef1b06f4996feb7587aa3281dcbd658e57535bc6b5e10110ed108e7a7a03/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f646973636f72642f626e6f6d65693f636f6c6f723d3732383964612669636f6e3d646973636f7264266c6162656c)](https://discordapp.com/users/bnomei)[![Buymecoffee](https://camo.githubusercontent.com/62e55d1129b82bf9c2fd4656451e81ab87a9787e7c9676ca58276532ed9666ee/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f69636f6e2f646f6e6174653f69636f6e3d6275796d6561636f6666656526636f6c6f723d464638313346266c6162656c)](https://www.buymeacoffee.com/bnomei)

Virtual Pages from APIs

Installation
------------

[](#installation)

- unzip [master.zip](https://github.com/bnomei/kirby-api-pages/archive/master.zip) as folder `site/plugins/kirby-api-pages` or
- `git submodule add https://github.com/bnomei/kirby-api-pages.git site/plugins/kirby-api-pages` or
- `composer require bnomei/kirby-api-pages`

Usage
-----

[](#usage)

You can find these examples in the tests of this repository.

### Records definition via Blueprint

[](#records-definition-via-blueprint)

**site/models/cats.php**

```
class CatsPage extends \Bnomei\APIRecordsPage {}
```

**site/blueprints/cat.yml**

```
title: Cat
fields:
    country:
        type: text
    origin:
        type: text
    coat:
        type: text
    pattern:
        type: text
```

**site/blueprints/cats.yml**

```
title: Cats

records:
  url: https://catfact.ninja/breeds
  query: data.sortBy("coat", "desc")
  template: cat
  # model: cat
  # expire: 60
  map:
    title: breed
    # omit or use * to select all
    # content: *
    # select a few by path
    content:
      country: country
      origin: origin
      coat: coat
      pattern: pattern

sections:
  catfacts:
    label: Virtual Pages from CatFacts API
    type: pages
    template: cat
```

### Records definition via Config

[](#records-definition-via-config)

**site/blueprints/rickandmorty.yml****site/blueprints/alien.yml****site/blueprints/human.yml**

**site/models/rickandmorty.php**

```
class RickandmortyPage extends \Bnomei\APIRecordsPage {}
```

**site/config/config.php**

```