Configuration Reference

php artisan vendor:publish --tag=geni-config

'title' => null, // defaults to config('app.name')
'version' => '1.0.0',
'description' => 'REST API documentation generated by Geni.',
'terms_of_service' => 'https://example.com/terms',

'contact' => [
    'name' => 'API Support',
    'email' => 'support@example.com',
    'url' => 'https://example.com/support',
],

'license' => [
    'name' => 'MIT',
    'url' => 'https://opensource.org/licenses/MIT',
],

// Routes matching this URI prefix are discovered for documentation.
// Matches whole path segments: 'api' does not pick up 'apiary/...' or 'api-legacy/...'.
'api_path' => 'api',

// Optional custom closure returning an array of Route objects:
'routes' => null,

// OpenAPI `servers`, as description => URL. Relative URLs go through url().
// Paths in the document stay absolute (e.g. /api/users), so point servers
// at the host, not the API prefix. Can also be set per entry in `apis`.
'servers' => [
    'Production' => 'https://api.example.com',
    'Local' => '/',
],

// Directories containing migration files for SchemaReader offline replay:
'migration_paths' => [
    database_path('migrations'),
],

// Manual escape hatch mapping 'table.column' => 'type' when migrations use raw SQL:
'schema_overrides' => [
    'users.balance' => 'number',
    'orders.metadata' => 'object',
],

// Middleware patterns that mark endpoints as protected:
'middleware_security' => [
    'auth',
    'auth:*',
],

// Default OpenAPI security scheme for matched endpoints:
'security_scheme' => [
    'type' => 'http',
    'scheme' => 'bearer',
    'bearerFormat' => 'JWT',
    'description' => 'Bearer token authentication',
],

// Per-middleware custom security schemes:
'middleware_security_schemes' => [
    'auth:sanctum' => [
        'name' => 'sanctumAuth',
        'scheme' => ['type' => 'http', 'scheme' => 'bearer', 'bearerFormat' => 'JWT'],
    ],
    'auth:api-key' => [
        'name' => 'apiKeyAuth',
        'scheme' => ['type' => 'apiKey', 'in' => 'header', 'name' => 'X-API-Key'],
    ],
],

// 'blade' (default), 'scalar', 'elements', or a class implementing Geni\Laravel\Renderer.
// Per API: set `renderer` inside an entry of `apis`.
'renderer' => 'blade',

'renderers' => [
    'blade' => [
        'tailwind_cdn_url' => 'https://cdn.tailwindcss.com/3.4.17',
        'alpine_cdn_url' => 'https://cdn.jsdelivr.net/npm/alpinejs@3.14.9/dist/cdn.min.js',
        'custom_css' => null,
    ],

    // Passed to Scalar.createApiReference() as-is (theme, layout, hideModels, ...).
    'scalar' => [
        'script_url' => null, // defaults to @scalar/api-reference@1.72.3 on jsDelivr
        'configuration' => [
            'theme' => 'laravel',
        ],
    ],

    // Stoplight Elements.
    'elements' => [
        'script_url' => null,     // defaults to @stoplight/elements@9.0.25 on jsDelivr
        'stylesheet_url' => null, // defaults to @stoplight/elements@9.0.25 on jsDelivr
        'layout' => 'sidebar',    // 'sidebar' | 'stacked'
        'hide_try_it' => false,
        'theme' => 'light',       // 'light' | 'dark'
    ],
],

// URLs where documentation UI and raw JSON specifications are served:
'docs_ui_path' => 'docs/api',
'docs_json_path' => 'docs/api.json',

// Outside 'local', docs routes are allowed when a `viewApiDocs` gate passes,
// return 403 when it denies, and 404 when no gate is defined.
// Set to false to skip this check and rely only on `docs_auth`.
'restrict_to_local' => true,

// Middleware applied to the docs UI routes. Add 'web' for user-based `viewApiDocs` gates:
'middleware' => [
    // 'web',
],

'docs_auth' => [
    // 'form' or 'basic'
    'mode' => env('GENI_DOCS_AUTH_MODE', 'basic'),
    'username' => env('GENI_DOCS_USERNAME'),
    'password' => env('GENI_DOCS_PASSWORD'),
],

'apis' => [
    'v1' => [
        'title' => 'API v1',
        'version' => '1.0.0',
        'api_path' => 'api/v1',
    ],
    'v2' => [
        'title' => 'API v2',
        'version' => '2.0.0',
        'api_path' => 'api/v2',
        'renderer' => 'scalar',                           // per-API renderer
        'servers' => ['Production' => 'https://api.example.com'],
        'extensions' => [App\Docs\BetaNotice::class],     // extensions for this API only
    ],
],

'mcp' => [
    'enabled' => true,
    'route_path' => 'docs/api/mcp',
    'tool_naming' => 'snake', // 'snake' or 'operation_id'
    'include_tags' => [],
    'exclude_tags' => [],
    'exclude_methods' => ['HEAD', 'OPTIONS'],

    // Allow `tools/call` over the HTTP endpoint (POST docs/api/mcp). Off by default:
    // when on, anyone who can open the docs can run any documented endpoint with the
    // credentials below. `geni:mcp:serve` (stdio) is not affected.
    'http_execution' => (bool) env('GENI_MCP_HTTP_EXECUTION', false),

    'execution' => [
        'base_url' => env('GENI_MCP_BASE_URL'),
        'timeout' => 15,
        'verify_ssl' => true,
        'auth' => [
            'default_bearer_token' => env('GENI_MCP_BEARER_TOKEN'),
            'default_api_key' => env('GENI_MCP_API_KEY'),
            'api_key_header' => 'X-API-Key',
        ],
    ],
],

// Classes implementing Geni\Laravel\Contracts\DocumentTransformer,
// Geni\Laravel\Contracts\OperationTransformer, Geni\Inference\RuleTransformer
// or Geni\Inference\ExceptionToResponse, applied to every API.
// Add an `extensions` list inside an entry of `apis` for one API only.
'extensions' => [
    App\Docs\SetTermsOfService::class,
],