setup.md

sidebar_position	1
sidebar_label	Setup

Running the rest server

You need to set up your restserver to handle ALL requests to a single PHP file. Normally is "app.php"

Create a file "app.php"

<?php
require_once __DIR__ . '/vendor/autoload.php';

// Define your routes
// The routes can be defined:
//   1. using PHP Attributes,
//   2. Closures
//   3. manually
//   4. or auto-generate from an OpenApi definition

// Set up the RestServer
$restServer = new \ByJG\RestServer\HttpRequestHandler();

// Optional configurations
$restServer
    ->withDefaultOutputProcessor(\ByJG\RestServer\OutputProcessor\JsonOutputProcessor::class)
    ->withDetailedErrorHandler()  // For development environments
    // ->withErrorHandlerDisabled()  // If you want to use your own error handler
    // ->withWriter(new CustomWriter())  // If you want to use a custom writer
    // ->withMiddleware($middleware, $routePattern)  // Add middleware
;

// Handle the request
// Parameters: routeDefinition, outputBuffer (default: true), session (default: false)
$restServer->handle($routeDefinition);

Configure your web server to handle all requests to "app.php"

PHP Built-in server

cd public
php -S localhost:8080 app.php

Nginx

location / {
  try_files $uri $uri/ /app.php$is_args$args;
}

Apache .htaccess

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ ./app.php [QSA,NC,L]