Custom route => re-generate api.json live on local, use cached on production

[mcorten]

Hello 👋 ,

We use a custom route for scramble (see code below) that checks de difference between local en production.
On production sites we want to use a cached version of the documentation (api.json) so they are not live calculated (i got this working)

On local we still want it to live generate, but i can not find a way how to do that.

My code:

Route::get('/api/****/***', function () {
    if (App::isLocal()) {
        // TODO find a way to live generate the api docs
    
        return view('scramble::docs', [
            'config' => Scramble::getGeneratorConfig('default'),
            // this should be live generated
            'spec' => file_get_contents(base_path('api.json')),
        ]);
    }

    /* return a cached version of the api.json for staging and production */
    if (App::isProduction()) {
        return view('scramble::docs', [
            'spec' => file_get_contents(base_path('api.json')),
            'config' => Scramble::getGeneratorConfig('default'),
        ]);
    }
});

[romalytvynenko]

Hey @mcorten! Cool, you're almost there! The only thing left is to inject a generator instance into the route's handler, and invoke it with the configuration (the generator instance is invokable). The result of the invocation is the OpenAPI document you're looking for.

use Dedoc\Scramble\Generator;

Route::get('/api/****/***', function (Generator $generator) {
    if (App::isLocal()) {
        return view('scramble::docs', [
            'config' => $config = Scramble::getGeneratorConfig('default'),
            'spec' => $generator($config),
        ]);
    }

    /* return a cached version of the api.json for staging and production */
    if (App::isProduction()) {
        return view('scramble::docs', [
            'spec' => file_get_contents(base_path('api.json')),
            'config' => Scramble::getGeneratorConfig('default'),
        ]);
    }
});

[mcorten]

thank you for your fast answer @romalytvynenko , your solution is working great