swagger_bake.php

<?php

use Cake\Core\Configure;

/**
 * ################################
 * # REQUIRED SETTINGS:
 * ################################
 *
 * @var string $prefix The route scope that SwaggerBake will scan for your APIs routes (e.g. `/api/`)
 *
 * @var string $yml A base Swagger YML file, see example in assets (e.g. `/config/swagger.yml`).
 *
 * @var string $json Web accessible file path the JSON file is written to (e.g. `/webroot/swagger.json`).
 *
 * @var string $webPath The URL browsers will use to access the JSON file (e.g. `/swagger.json`).
 *
 * ################################
 * # RECOMMENDED SETTINGS:
 * ################################
 *
 * @var bool $hotReload Regenerate swagger on page reloaded. This only works if you are using the built-in Swagger UI.
 *      Using your applications debug value is recommended as an easy way to define this.
 *      Default: false
 *
 * ################################
 * # OPTIONAL SETTINGS:
 * ################################
 * 
 * @var string $connectionName The connection name to use when loading tables for building schemas from models.
 *      Default: default
 *
 * @var array $editActionMethods The default HTTP methods to use for CakePHPs edit() action.
 *      Default: ['PATCH']
 *
 * @var int $jsonOptions A bitmask of options passed as second parameter to json_encode function. Accepted values are
 *      described at https://www.php.net/manual/en/function.json-encode.php
 *      Default: JSON_PRETTY_PRINT
 *
 * @var string[] $requestAccepts Array of mime types accepted. Can be used if your application accepts JSON, XML etc...
 *      Default: ['application/json']
 *
 * @var string[] $responseContentTypes Array of mime types returned. Can be used if your application returns XML etc...
 *      Default: ['application/json']
 *
 * @var string $docType The default doc type. Options are swagger and redoc.
 *      Default: swagger
 *
 * @var string|null $exceptionSchema The short name of your Exception schema in swagger.yaml components > schemas.
 *      Default: Exception.
 *
 * @var array[] $namespaces Array of namespaces. Useful if your controllers or entities exist in non-standard
 *      namespace such as a plugin. This was mostly added to aid in unit testing, but there are cases where controllers
 *      may exist in a plugin namespace etc...
 *      Default: ['controllers' => ['\App\\'], 'entities' => ['\App\\'], 'tables' => ['\App\\']]
 */
return [
    'SwaggerBake' => [
        'prefix' => '/your-relative-api-url',
        'yml' => '/config/swagger.yml',
        'json' => '/webroot/swagger.json',
        'webPath' => '/swagger.json',
        'hotReload' => Configure::read('debug'),
        'jsonOptions' => JSON_PRETTY_PRINT,
        /*
        'editActionMethods' => ['PATCH'],
        'requestAccepts' => [
            'application/json',
            'application/x-www-form-urlencoded',
            'application/xml',
        ],
        'responseContentTypes' => [
            'application/json',
            'application/xml',
            'application/hal+json',
            'application/json+ld'
        ],
        'docType' => 'swagger',
        'exceptionSchema' => 'Exception',
        'namespaces' => [
            'controllers' => ['\App\\'],
            'entities' => ['\App\\'],
            'tables' => ['\App\\']
        ],
        */
    ]
];