Level 80
@devondahon API routes aren’t prefixed by default: https://github.com/laravel/laravel/blob/8.x/app/Providers/RouteServiceProvider.php#L41-L44
If you want a path prefix then yes, you’ll need to add it to the route group.
1 like
Feb 12, 2021
5
Level 3
api route prefix lost with $this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
I'm registering API routes in a package service provider like this:
$this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
But then, the api/ route prefix is not applied anymore to routes set in api.php, should I put the routes in:
Route::prefix('api')->group(function () {
...
}
Or do I have something misconfigured ?
Level 3
Ok, indeed, the prefix is added in the route provider:
/**
* Define your route model bindings, pattern filters, etc.
*
* @return void
*/
public function boot()
{
$this->configureRateLimiting();
$this->routes(function () {
Route::prefix('api')
->middleware('api')
->namespace($this->namespace)
->group(base_path('routes/api.php'));
Route::middleware('web')
->namespace($this->namespace)
->group(base_path('routes/web.php'));
});
}
How to adapt the same configuration to MyPackageServiceProvider.php below?
class MyPackageServiceProvider extends ServiceProvider
{
public function boot()
{
$this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
}
}
Level 80
@devondahon Your package isn’t loaded in the RouteServiceProvider, so you’ll need to apply any prefixes, middleware, etc to any loads you load in your packages’ service providers.
Level 3
@martinbean Thanks Martin!
So for instance, how to add ->prefix('api') to my routes in MyPackageServiceProvider.php ?
Something like this ?
$this->loadRoutesFrom(__DIR__ . '/../routes/api.php')->prefix('api');
Level 80
@devondahon You can just use the Route facade as you can in a Laravel application proper:
use Illuminate\Support\Facades\Route;
use Illuminate\Support\ServiceProvider;
class YourPackageServiceProvider extends ServiceProvider
{
public function boot()
{
Route::middleware('api')->prefix('api')->group(function () {
$this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
});
}
}
3 likes
Please or to participate in this conversation.