Introduction

Installation

You can install the package via composer:

composer require tartanlegrand/laravel-openapi

The service provider will automatically get registered. Or you may manually add the service provider in your config/app.php file:

'providers' => [
    // ...
    Vyuldashev\LaravelOpenApi\OpenApiServiceProvider::class,
];

You can publish the config file with:

php artisan vendor:publish --provider="Vyuldashev\LaravelOpenApi\OpenApiServiceProvider" --tag="openapi-config"

Additional information

Before starting using this package you need to be familiar with OpenAPI specification and it's terms.

Here are some useful links that will help to gain enough knowledge:

• OpenAPI Specification (opens new window)
• OpenAPI Map (opens new window)
• Swagger Editor (opens new window)

Generating OpenAPI document

In order to generate OpenAPI document run Artisan command:

php artisan openapi:generate