root
52 lines
1.7 KiB
PHP
52 lines
1.7 KiB
PHP
<?php
|
|
|
|
return [
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| SPA base URL for API documentation (React/Vue client)
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Used by web redirects (e.g. `/`) so browsers land on the Swagger UI SPA
|
|
| instead of a Blade view.
|
|
|
|
|
*/
|
|
|
|
'client_url' => env('DOCS_CLIENT_URL', 'http://localhost:5173'),
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Docs hub (legacy: `DocsController::index` / docs/index view)
|
|
|--------------------------------------------------------------------------
|
|
*/
|
|
|
|
'index' => [
|
|
'title' => env('DOCS_INDEX_TITLE', 'API documentation'),
|
|
'description' => env('DOCS_INDEX_DESCRIPTION', ''),
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Static OpenAPI YAML files (legacy: public/docs/*.yaml + View\DocsController::swagger)
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Deploy the same YAML files under `public/docs/` or adjust paths. Dropdown
|
|
| URLs are built via ApplicationUrlService::absolutePublicPathUrl in DocsCatalogService.
|
|
| The merged JSON is served at GET /api/documentation/swagger.json (route name
|
|
| `docs.swagger-json`; see DocsCatalogController::swaggerMergedJson).
|
|
|
|
|
*/
|
|
|
|
'swagger_specs' => [
|
|
[
|
|
'name' => 'Administrator API',
|
|
'path' => '/docs/openapi_administrator_controller.yaml',
|
|
],
|
|
[
|
|
'name' => 'Parent API',
|
|
'path' => '/docs/openapi_parent_controller.yaml',
|
|
],
|
|
],
|
|
|
|
];
|