OpenAPI Initializer

 OpenAPI Initializer is a Laravel package that provides a straightforward command to scaffold an OpenAPI spec file.

Once you install the package, you can run the artisan command to walk you through various questions to make the OpenAPI specification.

You start by running the command:

1php artisan openapi:create

Then the plugin will walk you through a bunch of questions to construct the specification file:

Once you walk through the questions, OpenAPI Initializer will generate an openapi.yml specification file that will look similar to the following:

 1openapi: 3.0.3
 2info:
 3    title: ''
 4    version: 0.1.0
 5    description: 'Test API'
 6    contact: { name: 'Laravel News', email: user@example.com, url: null }
 7servers:
 8    - { url: 'http://openapi-demo.test', description: 'Local url for testing' }
 9tags: null
10paths: null
11components:
12    schemas: null
13    responses: null
14    headers: null
15    parameters: null
16    links: null
17    examples: null

You can learn more about this package, get full installation instructions, and view the source code on GitHub. If you’d like the know more about OpenAPI, I suggest an OpenAPI 3.0 Tutorial and the OpenAPI Specification (3.0.3) document.

Read More

Simplifying Service Providers With Laravel Package Tools

 Laravel Package Tools is a package by Spatie that provides an opinionated base service provider you can use to streamline the registration of your package’s config files, migrations, commands, and more.

Here’s how to simplify service providers in @laravelphp packageshttps://t.co/qKmIO7nUJY

Spoiler: I released a package for that https://t.co/URH2udPbiJ#php #laravel pic.twitter.com/tWCGuE8HG8

— Freek Van der Herten (@freekmurze) January 25, 2021

I think you’ll agree that this package can streamline common use-cases found in package service providers:

 1use Spatie\LaravelPackageTools\PackageServiceProvider;
 2use Spatie\LaravelPackageTools\Package;
 3 
 4class YourPackageServiceProvider extends PackageServiceProvider
 5{
 6    public function configurePackage(Package $package) : void
 7    {
 8        $package
 9            ->name('your-package-name')
10            ->hasConfigFile()
11            ->hasViews()
12            ->hasTranslations()
13            ->hasMigration('create_package_tables')
14            ->hasCommand(YourCoolPackageCommand::class);
15    }
16}

Spatie also provides a skeleton Laravel package you can use as a template for your next package project. The Laravel skeleton uses the package tools service provider out of the box.

Read More

Use Basecamp’s Hotwire in Laravel

 Turbo Laravel is a package that gives you a set of conventions to get the most out of Hotwire in Laravel. Turbo is inspired by the turbo-rails gem, giving Laravel developers a similar experience as those developing with Hotwire in the Ruby world.

Hotwire is an open-source tool built by Basecamp (it powers the HEY email service), which provides an alternative approach to building modern web applications without using much JavaScript and sending HTML instead of JSON over the wire.

Turbo Laravel supports Turbo features outlined by the Hotwire documentation. For those new to Hotwire, here are the descriptions of each technique from the website:

• Turbo Drive – accelerates links and form submissions by negating the need for full page reloads.
• Turbo Frames – decompose pages into independent contexts, which scope navigation and can be lazily loaded.
• Turbo Streams – deliver page changes over WebSocket, SSE or in response to form submissions using just HTML and a set of CRUD-like actions.
• Turbo Native – lets your majestic monolith form the center of your native iOS and Android apps, with seamless transitions between the web and native sections.

Along with this package, there is a turbo-laravel-test-helpers companion package that adds a couple of macros and assertion helpers to test your applications built with Turbo Laravel:

 1/** @test */
 2public function turbo_stream_test()
 3{
 4    $response = $this->turbo()->post('my-route');
 5 
 6    $response->assertTurboStream();
 7 
 8    // Checks if one of the Turbo Stream responses matches these criteria.
 9    $response->assertHasTurboStream($target = 'users', $action = 'append');
10 
11    // Checks if there is no Turbo Stream tag for the criteria.
12    $response->assertDoesntHaveTurboStream($target = 'empty_users', $action = 'remove');
13}

Read More