# Introduction

# Installation

You can install the package via composer:

composer require vyuldashev/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

This package use some annotations. If you are using PhpStorm consider installing PHP Annotations plugin.

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:

# Generating OpenAPI document

In order to generate OpenAPI document run Artisan command:

php artisan openapi:generate