This is the Scramble extension, which detects the usage of the Spatie query builder in your api routes and automatically adds applicable query parameters to the openapi definition.
composer install exonn-gmbh/scramble-spatie-query-builder
- Register the extension in your
config/scramble.phpfile
'extensions' => [
// ...
\Exonn\ScrambleSpatieQueryBuilder\AllowedFieldsExtension::class
\Exonn\ScrambleSpatieQueryBuilder\AllowedSortsExtension::class
\Exonn\ScrambleSpatieQueryBuilder\AllowedFiltersExtension::class
\Exonn\ScrambleSpatieQueryBuilder\AllowedFilterModesExtension::class
\Exonn\ScrambleSpatieQueryBuilder\AllowedIncludesExtension::class
],- You are done, now check your Scramble docs for routes that use Spatie query builder, you should see new query parameters documented
By default this extension automatically updates openapi definition for you, but if you want to customize its default behaviour, you can do it in the following way
- Open your
AppServiceProvider.phpand add the following code example in thebootmethod
public function boot(): void
{
// ...
AllowedIncludesExtension::hook(function(Operation $operation, Parameter $parameter) {
// Customize the example
$parameter->example(['repositories.issues', 'repositories']);
// Customize the description
$parameter->description('Allows you to include additional model relations in the response');
});
}- Customize for your needs
- Add tests
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent