mirror of
https://github.com/vitodeploy/vito.git
synced 2025-07-03 06:56:15 +00:00
32 lines
1.4 KiB
PHP
32 lines
1.4 KiB
PHP
<?php
|
|
|
|
// Only the most common configs are shown. See the https://scribe.knuckles.wtf/laravel/reference/config for all.
|
|
|
|
return [
|
|
// The HTML <title> for the generated documentation.
|
|
'title' => 'API Documentation',
|
|
|
|
// A short description of your API. Will be included in the docs webpage, Postman collection and OpenAPI spec.
|
|
'description' => 'VitoDeploy\'s API documentation.',
|
|
|
|
// The base URL displayed in the docs.
|
|
// If you're using `laravel` type, you can set this to a dynamic string, like '{{ config("app.tenant_url") }}' to get a dynamic base URL.
|
|
'base_url' => config('app.url'),
|
|
|
|
// The type of documentation output to generate.
|
|
// - "static" will generate a static HTMl page in the /public/docs folder,
|
|
// - "laravel" will generate the documentation as a Blade view, so you can add routing and authentication.
|
|
// - "external_static" and "external_laravel" do the same as above, but pass the OpenAPI spec as a URL to an external UI template
|
|
'type' => 'static',
|
|
|
|
// See https://scribe.knuckles.wtf/laravel/reference/config#theme for supported options
|
|
'theme' => 'default',
|
|
|
|
'static' => [
|
|
// HTML documentation, assets and Postman collection will be generated to this folder.
|
|
// Source Markdown will still be in resources/docs.
|
|
'output_path' => 'public/api-docs',
|
|
'url' => '/api-docs/index.html',
|
|
],
|
|
];
|