AppApi - Page

AppApiPage adds the /page endpoint to the AppApi routes definition. Makes it possible to query pages via the api.

Relies on AppApi:

Installation

AppApiPage relies on the base module AppApi, which must be installed before AppApiPage can do its work.

AppApi and AppApiPage can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules

The prerequisites are PHP>=7.2.0 and a ProcessWire version >=3.93.0 (+ AppApi>=1.2.0). However, this is also checked during the installation of the module. No further dependencies.

Quickstart

AppApiPage will add an api-endpoint that can be used to call any page in the processwire pagetree.

Simply add the following code at the top of your ProcessWire-template to add JSON output:

<?php
// Check if AppApi is available:
if (wire('modules')->isInstalled('AppApi')) {
  $module = $this->wire('modules')->get('AppApi');
  // Check if page was called via AppApi
  if($module->isApiCall()){
    // Output id & name of current page
    $output = [
      'id' => wire('page')->id,
      'name' => wire('page')->name
    ];

    // sendResponse will automatically convert $output to a JSON-string:
    AppApi::sendResponse(200, $output);
  }
}

// Here continue with your HTML-output logic...

Changelog

Changes in 1.0.2 (2022-06-01)

• Bugfix throw 404 status if not found

Changes in 1.0.1 (2022-04-29)

• Added support for Multi-Language URLS

Changes in 1.0.0 (2022-03-06)

• Added page endpoint

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Mozilla Public License Version 2.0 - see the LICENSE.md file for details.