PHPackages                             syn/laravel-swagger-json-api-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. syn/laravel-swagger-json-api-generator

ActiveLibrary

syn/laravel-swagger-json-api-generator
======================================

The package implements automatic generation of the Open Api specification for the laravel-json-api package

0.2.15(1y ago)121GPL-3.0-onlyPHPPHP ^8.1

Since Mar 3Pushed 1y ago2 watchersCompare

[ Source](https://github.com/skolosov/laravel-swagger-json-api-generator)[ Packagist](https://packagist.org/packages/syn/laravel-swagger-json-api-generator)[ RSS](/packages/syn-laravel-swagger-json-api-generator/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (2)Versions (6)Used By (0)

laravel-swagger-json-api-generator
==================================

[](#laravel-swagger-json-api-generator)

Установка
---------

[](#установка)

```
composer require syn/laravel-swagger-json-api-generator
```

опубликовать файлы:

```
php artisan vendor:publish --provider=Syn\LaravelSwaggerJsonApiGenerator\Providers\ServiceProvider
```

### Команда опубликует

[](#команда-опубликует)

- файл кофигурации ***swagger-jsonapi-generator.php***
- директорию ***docs*** для хранения собственных путей и компонентов OpenApi

### важно!!!

[](#важно)

Добавить в **config/filesystems.php** новый драйвер хранилища документации

```
    'docs' => [
        'driver' => 'local',
        'root' => docs_path(),
        'throw' => false,
    ],
```

Базовое использование
---------------------

[](#базовое-использование)

для того что бы сгенерировать документацию по спецификации JsonApi для маршрутов пакета [laravel-json-api/laravel](https://laraveljsonapi.io/)необходимо настроить файл конфигурации

### config/swagger-jsonapi-generator.php

[](#configswagger-jsonapi-generatorphp)

```