Skip to content

Module Configuration

Sebastian Schendel edited this page Nov 1, 2025 · 4 revisions

AppApi has several configuration parameters in the module settings that you can use to customize the module to your requirements.

  • API Endpoint: Lets you choose under which url your api should be available (default „api“)
  • Path to Routes.php: Location of the Routes.php file, where AppApi will find the $routes definition array. Base of path: ProcessWire-Root (Location of index.php) (default „site/api/Routes.php“)
  • Activate Access-Logging: Activate when you want to have access logging for your api. Will write access-data in "appapi-access.txt" log. (default: false)
  • Deactivate URL Hook: Will deactivate route-handling by ProcessWire URL hook and fallback to ProcessPageView::pageNotFound hook.
  • Use URLs relative to ProcessWire root: If activated, all URLs returned by the api endpoints will be relative to the ProcessWire root URL. Can be useful if ProcessWire is installed in a sub-directory. [new in v1.4.0]
  • Disable the automatic setting of Access-Control-Allow-Origin headers: If activated, AppApi will not add any access-control-headers by itself. You need to take care of that on your own to prevent CORS issues.

➡️ Continue with 2.0: Defining Applications

⬅️ Back to Changelog

Clone this wiki locally