PHPackages                             sonata/docs - 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. [API Development](/categories/api)
4. /
5. sonata/docs

ActiveLibrary[API Development](/categories/api)

sonata/docs
===========

OpenAPI docs module for Sonata framework

v1.0.2(4mo ago)038PHPPHP ^8.3

Since Feb 7Pushed 4mo agoCompare

[ Source](https://github.com/DimsHewiks/sonata-docs)[ Packagist](https://packagist.org/packages/sonata/docs)[ RSS](/packages/sonata-docs/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (2)Versions (4)Used By (0)

Sonata Docs
===========

[](#sonata-docs)

Модуль OpenAPI для Sonata Framework. Генерирует спецификацию и отдает ее через эндпоинт.

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

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

```
composer require sonata/docs
```

Эндпоинты
---------

[](#эндпоинты)

Контроллер `Sonata\Docs\Controllers\SwaggerController` подключается автоматически:

- `GET /openapi.json` — OpenAPI спецификация

Логика
------

[](#логика)

- Генератор `OpenApiGenerator` сканирует контроллеры и DTO.
- Использует атрибуты `#[Route]`, `#[Controller]`, `#[Tag]`, `#[Response]`, `#[From]`.
- В `prod` режиме применяет `OpenApiCache`.

Атрибуты для документации
-------------------------

[](#атрибуты-для-документации)

Используйте атрибуты Sonata Framework и OpenAPI:

- `#[Tag('Название', 'Описание')]` — группировка методов
- `#[Response(Dto::class, isArray: true)]` — схема ответа
- `#[From('json'|'query')]` — источник данных
- `#[OpenApi\Attributes\Property(...)]` — описание полей DTO

Пример:

```
use OpenApi\Attributes as OA;
use Sonata\Framework\Attributes\Response;
use Sonata\Framework\Attributes\Tag;

#[Tag('Пользователи')]
class UserController
{
    #[Response(UserResponse::class, isArray: true)]
    public function list(): array { /* ... */ }
}

final class UserResponse
{
    #[OA\Property(example: 1, description: 'ID пользователя')]
    public int $id;
}
```

Swagger UI
----------

[](#swagger-ui)

UI в комплект не входит. Можно:

1. Использовать локальные ассеты (как в приложении `view/swagger`).
2. Подключить Swagger UI через CDN и указывать `/openapi.json` как источник.

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance74

Regular maintenance activity

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

146d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/143056381?v=4)[DimsHewiks](/maintainers/DimsHewiks)[@DimsHewiks](https://github.com/DimsHewiks)

---

Top Contributors

[![DimsHewiks](https://avatars.githubusercontent.com/u/143056381?v=4)](https://github.com/DimsHewiks "DimsHewiks (3 commits)")

### Embed Badge

![Health badge](/badges/sonata-docs/health.svg)

```
[![Health](https://phpackages.com/badges/sonata-docs/health.svg)](https://phpackages.com/packages/sonata-docs)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

3.0k37.6M134](/packages/darkaonline-l5-swagger)[nelmio/api-doc-bundle

Generates documentation for your REST API from attributes

2.4k67.4M263](/packages/nelmio-api-doc-bundle)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M574](/packages/shopware-core)[tangwei/apidocs

A swagger library for Hyperf.

53137.0k8](/packages/tangwei-apidocs)[hyperf/swagger

A swagger library for Hyperf.

20371.1k7](/packages/hyperf-swagger)[pimcore/studio-backend-bundle

Pimcore Studio Backend Bundle

20203.9k22](/packages/pimcore-studio-backend-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)