laravel-fast-endpoints

Configuration

The Laravel Fast Endpoints (LFE) package allows for a variety of configurations to suit your project’s needs. You can configure the package by modifying the fast-endpoints.php configuration file. Below is a detailed explanation of each configuration option along with code examples.

Filesystem Destination `dist`

This option defines the base directory where the fast-endpoints package will start scanning for endpoint classes. Ensure that all your endpoint classes are located within or under this directory so they are automatically detected and registered.

'dist' => app_path('Http/Endpoints'),

If you place your endpoint classes in app/Http/Endpoints, the package will scan this directory and all its subdirectories to generate routes.

Routes Prefix: `prefix`

The prefix option allows you to prepend a common URI segment to all routes generated by the fast-endpoints package. This is useful for organizing your routes under a specific path, such as /api or /v1.

'prefix' => 'fast',

With a prefix of fast, an endpoint defined at /users would be accessible at /fast/users.

If you don’t want a prefix, leave this option empty:

'prefix' => '',

Routes Domain `domain`

This option allows you to specify a domain that all fast-endpoints routes should respond to. If set to null, the routes will be available on any domain.

'domain' => null,

To restrict routes to a specific subdomain, you might set this to:

'domain' => 'api.yourdomain.com',

Routes Middleware `middleware`

This option lets you apply middleware to all fast-endpoints routes. Middleware can handle tasks like authentication, authorization, or other request filtering. If set to null, no middleware will be applied by default.

'middleware' => null,

To apply authentication middleware to all routes:

'middleware' => ['auth'],

Routes Groups `groups`

You can define additional route groups with specific configurations such as domain, prefix, or middleware. These groups can be applied to endpoint classes using the Group attribute, allowing for more organized and manageable routes.

'groups' => null,

Define a group for admin routes:

'groups' => [
	'admin' => [
		'prefix' => 'admin',
		'middleware' => ['auth', 'role:admin'],
	],
],

Apply this group in an endpoint class:

#[Group('admin')]
class AdminDashboardEndpoint {
	// Endpoint logic here...
}

Routes Namespaces `namespaces`

This option allows you to apply configurations automatically based on the namespaces of the endpoint classes. This ensures consistent routing configurations without needing manual grouping.

'namespaces' => null,

Define configurations for a specific namespace:

'namespaces' => [
	'App\Http\Endpoints\Admin' => [
		'prefix' => 'admin',
		'middleware' => ['auth', 'role:admin'],
	],
],

Request Handler `request`

This configuration option specifies the default class used for handling incoming requests for Fast Endpoints.

'request' => Illuminate\Http\Request::class,

If you need to customize the request handling, you can extend the default Request class:

'request' => App\Http\Requests\CustomRequest::class,

Response Handler `response`

This configuration option specifies the default class used for handling responses for Fast Endpoints.

'response' => Illuminate\Http\Response::class,

To customize the response handling, extend the default Response class:

'response' => App\Http\Responses\CustomResponse::class,

Prev - Installation

Next - Endpoints

This site is open source. Improve this page.

laravel-fast-endpoints

Configuration

Filesystem Destination dist

Routes Prefix: prefix

Routes Domain domain

Routes Middleware middleware

Routes Groups groups

Routes Namespaces namespaces

Request Handler request

Response Handler response