README

Create Laravel commands for your OpenAPI specs

Turn any OpenAPI spec into dedicated Laravel artisan commands. Each endpoint gets its own command with typed options for path parameters, query parameters, and request bodies. Combined with Laravel Zero, this is a great way to build standalone CLI tools for any API that has an OpenAPI spec.

use Spatie\OpenApiCli\Facades\OpenApiCli;

OpenApiCli::register('https://api.bookstore.io/openapi.yaml', 'bookstore')
    ->baseUrl('https://api.bookstore.io')
    ->auth(fn () => app(OAuthTokenManager::class)->token())
    ->banner('Bookstore API v2')
    ->cache(ttl: 600)
    ->followRedirects()
    ->yamlOutput()
    ->showHtmlBody()
    ->useOperationIds()
    ->onError(function (Response $response, Command $command) {
        return match ($response->status()) {
            429 => $command->warn('Rate limited. Retry after '.$response->header('Retry-After').'s.'),
            default => false,
        };
    })
    ->retryOn(function (Response $response, Command $command) {
        if ($response->status() !== 401) {
            return false;
        }

        return app(OAuthTokenManager::class)->refresh();
    }, maxRetries: 1);

For a spec with GET /books, POST /books, GET /books/{book_id}/reviews, and DELETE /books/{book_id}, you get these commands:

• bookstore:get-books
• bookstore:post-books
• bookstore:get-books-reviews
• bookstore:delete-books
• bookstore:list

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Documentation

All documentation is available on our documentation site.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Alex Vanderbist
• All Contributors

License

The MIT License (MIT). Please see License File for more information.