154 lines
4.4 KiB
PHP
154 lines
4.4 KiB
PHP
<?php
|
|
|
|
return [
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| API Vendor
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Your vendor is used in the "Accept" request header and will be used by
|
|
| the consumers of your API. Typically this will be the name of your
|
|
| application or website.
|
|
|
|
|
*/
|
|
|
|
'vendor' => 'cachet',
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Default API Version
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| When a request is made to the API and no version is specified then it
|
|
| will default to the version specified here.
|
|
|
|
|
*/
|
|
|
|
'version' => 'v1',
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Default API Prefix
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| A default prefix to use for your API routes so you don't have to
|
|
| specify it for each group.
|
|
|
|
|
*/
|
|
|
|
'prefix' => 'api',
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Default API Domain
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| A default domain to use for your API routes so you don't have to
|
|
| specify it for each group.
|
|
|
|
|
*/
|
|
|
|
'domain' => null,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Conditional Requests
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Globally enable conditional requests so that an ETag header is added to
|
|
| any successful response. Subsequent requests will perform a check and
|
|
| will return a 304 Not Modified. This can also be enabled or disabled
|
|
| on certain groups or routes.
|
|
|
|
|
*/
|
|
|
|
'conditional_request' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Authentication Providers
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| The authentication providers that should be used when attempting to
|
|
| authenticate an incoming API request.
|
|
|
|
|
*/
|
|
|
|
'auth' => [
|
|
'basic' => function ($app) {
|
|
return new Dingo\Api\Auth\BasicProvider($app['auth']);
|
|
}
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Rate Limiting
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Consumers of your API can be limited to the amount of requests they can
|
|
| make. You can configure the limit based on whether the consumer is
|
|
| authenticated or unauthenticated.
|
|
|
|
|
| The "limit" is the number of requests the consumer can make within a
|
|
| certain amount time which is defined by "reset" in minutes.
|
|
|
|
|
| By default rate limiting is disabled.
|
|
|
|
|
*/
|
|
|
|
'rate_limiting' => [
|
|
|
|
'authenticated' => [
|
|
'limit' => 0,
|
|
'reset' => 60
|
|
],
|
|
|
|
'unauthenticated' => [
|
|
'limit' => 0,
|
|
'reset' => 60
|
|
],
|
|
|
|
'exceeded' => 'API rate limit has been exceeded.'
|
|
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Response Transformer
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Responses can be transformed so that they are easier to format. By
|
|
| default a Fractal transformer will be used to transform any
|
|
| responses prior to formatting. You can easily replace
|
|
| this with your own transformer.
|
|
|
|
|
*/
|
|
|
|
'transformer' => function ($app) {
|
|
$fractal = new League\Fractal\Manager;
|
|
|
|
return new Dingo\Api\Transformer\FractalTransformer($fractal);
|
|
},
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Response Formats
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Responses can be returned in multiple formats by registering different
|
|
| response formatters. You can also customize an existing response
|
|
| formatter.
|
|
|
|
|
*/
|
|
|
|
'default_format' => 'json',
|
|
|
|
'formats' => [
|
|
|
|
'json' => new Dingo\Api\Http\ResponseFormat\JsonResponseFormat
|
|
|
|
]
|
|
|
|
];
|