PHPackages gollumsf/rest-doc-bundle - 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. [HTTP & Networking](/categories/http) 4. / 5. gollumsf/rest-doc-bundle ActiveSymfony-bundle[HTTP & Networking](/categories/http) gollumsf/rest-doc-bundle ======================== Auto-Generate documentation API for GollumSF\\RestBundle v3.1.1(2mo ago)13971[2 PRs](https://github.com/GollumSF/rest-doc-bundle/pulls)GPL-3.0-or-laterPHPPHP >=8.2CI passing Since Jan 30Pushed 2mo ago1 watchersCompare [ Source](https://github.com/GollumSF/rest-doc-bundle)[ Packagist](https://packagist.org/packages/gollumsf/rest-doc-bundle)[ Docs](https://github.com/GollumSF/rest-doc-bundle)[ RSS](/packages/gollumsf-rest-doc-bundle/feed)WikiDiscussions master Synced 3w ago READMEChangelog (10)Dependencies (23)Versions (21)Used By (0) GollumSF/RestDocBundle ====================== [](#gollumsfrestdocbundle) [![Build Status](https://github.com/GollumSF/rest-doc-bundle/actions/workflows/symfony_6.4.yml/badge.svg?branch=master)](https://github.com/GollumSF/rest-doc-bundle/actions)[![Build Status](https://github.com/GollumSF/rest-doc-bundle/actions/workflows/symfony_7.4.yml/badge.svg?branch=master)](https://github.com/GollumSF/rest-doc-bundle/actions)[![Build Status](https://github.com/GollumSF/rest-doc-bundle/actions/workflows/symfony_8.0.yml/badge.svg?branch=master)](https://github.com/GollumSF/rest-doc-bundle/actions) [![Coverage](https://camo.githubusercontent.com/f00ff1c33e3650b97c3a2ab35e9f53b298e82cff718494ff8b5bfb483e59677f/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f476f6c6c756d53462f726573742d646f632d62756e646c652f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/GollumSF/rest-doc-bundle)[![License](https://camo.githubusercontent.com/ddb98733798819cd218ea3b9a2fbb873514b9f0318c1c0dc07904e5a1f403dc3/68747470733a2f2f706f7365722e707567782e6f72672f676f6c6c756d73662f726573742d646f632d62756e646c652f6c6963656e7365)](https://packagist.org/packages/gollumsf/rest-doc-bundle)[![Latest Stable Version](https://camo.githubusercontent.com/f4500d66c9310494da9352cc2464ee8bb62b926d4d091f4163a46791de4dcaa0/68747470733a2f2f706f7365722e707567782e6f72672f676f6c6c756d73662f726573742d646f632d62756e646c652f762f737461626c65)](https://packagist.org/packages/gollumsf/rest-doc-bundle)[![Latest Unstable Version](https://camo.githubusercontent.com/f27eb46e38e18560b05909709ada8c7b238e9770e73a93829e2550d6638f0dc9/68747470733a2f2f706f7365722e707567782e6f72672f676f6c6c756d73662f726573742d646f632d62756e646c652f762f756e737461626c65)](https://packagist.org/packages/gollumsf/rest-doc-bundle)[![Discord](https://camo.githubusercontent.com/e2ea9d7fb91494f17c7c76925e006e2ad2d7586fa54f500364bddda1520eecb1/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3637313734313934343134393537333638373f636f6c6f723d707572706c65266c6162656c3d646973636f7264)](https://discord.gg/xMBc5SQ) Auto-Generate documentation API for GollumSF\\RestBundle : Requirements: ------------- [](#requirements) - PHP >= 8.2 - Symfony 6.4, 7.x or 8.0 Installation: ------------- [](#installation) ``` composer require gollumsf/rest-doc-bundle ``` ### config/bundles.php [](#configbundlesphp) ``` return [ // [ ... ] GollumSF\RestBundle\GollumSFRestDocBundle::class => ['all' => true], ]; ``` Configuration: -------------- [](#configuration) All configurations is optionals. Edit file `config/packages/gollum_sf_rest_doc.yaml` : ``` gollum_sf_rest_doc: ################# # Documentation # ################# title: 'REST Api' # optional, default : REST Api version: '1.0.0' # optional, default : 1.0.0 description: 'Api general description' # optional, default : null external_docs: # optional url: 'https://github.com/GollumSF/rest-doc-bundle' # required description: 'External documentation description' # optional, default : null ############## # Host / URL # ################ host: # optional, default : null (return current host url) - 'dev.api.com' - 'preprod.api.com' - 'prod.api.com' default_host: 'dev.api.com' # optional, default : null (return first item to host list) protocol: # optional, default : null (return current sheme url) - 'http' - 'https' default_protocol: 'http' # optional, default : null (return first item to protocol list) ############ # Security # ############ security: # optional (No security token if not defined) my_first_configuration: type: 'authorization_bearer' # required, authorization_bearer generate classic authorization bearer name: 'Authorization' # optional, default: Authorization, the header name scheme: 'BEARER' # optional, default: BEARER, the scheme in header value defaultValue: 'TOKEN_DEMO' # optional, the default token value for demo my_second_configuration: type: 'query_param' # required, query_param generate query string token name: 'token' # optional, default: token, the query name defaultValue: 'TOKEN_DEMO' # optional, the default token value for demo my_custom_configuration: type: 'custom' # required, custom generate a custom configuration based on: defaultValue: 'TOKEN_DEMO' # optional, the default token value for demo data: # required, Data based on securitySchemes content type: 'http' # - show : https://swagger.io/docs/specification/authentication/ scheme: 'basic' ``` Integration with [Swagger](https://github.com/swagger-api/swagger-ui): ---------------------------------------------------------------------- [](#integration-with-swagger) ``` #app/config/routing.yml gsf_restbundle_swagger: resource: "@GollumSFRestDocBundle/Resources/config/swagger_routing.yml" prefix: /api-docs ``` Integration with OpenApi JSON: ------------------------------ [](#integration-with-openapi-json) ``` gsf_restbundle_openapi: resource: "@GollumSFRestDocBundle/Resources/config/openapi_routing.yml" prefix: /api-docs.json ``` Attributes: ----------- [](#attributes) The documentation is automatically generated from your controllers using `#[Serialize]` and `#[Unserialize]` attributes from [RestBundle](https://github.com/GollumSF/rest-bundle). No additional configuration is needed for basic API documentation. You can optionally enrich the generated documentation with these attributes: ### ApiDescribe (on controller methods) [](#apidescribe-on-controller-methods) Override or add metadata for a specific route: ``` use GollumSF\RestDocBundle\Annotation\ApiDescribe; #[ApiDescribe(entity: Book::class, serializeGroups: ['book_get'])] public function list() { ... } ``` ### ApiEntity (on entity classes) [](#apientity-on-entity-classes) Add description and URL metadata to an entity: ``` use GollumSF\RestDocBundle\Annotation\ApiEntity; #[ApiEntity(description: 'A book entity', url: '/api/books')] class Book { // ... } ``` ### ApiProperty (on entity properties) [](#apiproperty-on-entity-properties) Override the auto-detected type or description of a property: ``` use GollumSF\RestDocBundle\Annotation\ApiProperty; class Book { #[ApiProperty(type: 'integer')] private int $id; #[ApiProperty(type: 'string')] private string $title; } ``` ### Health Score 51 — FairBetter than 95% of packages Maintenance83 Actively maintained with recent releases Popularity18 Limited adoption so far Community10 Small or concentrated contributor base Maturity79 Established project with proven stability Bus Factor1 Top contributor holds 98.9% 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 ~133 days Recently: every ~365 days Total 18 Last Release 87d ago Major Versions v1.1.1 → v2.0.02020-02-03 v2.8.3 → v3.0.02026-03-26 PHP version history (3 changes)v1.0.0PHP ^7.2 v2.8.1PHP >=7.2 v3.0.0PHP >=8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/6690bb36165854e1db86762d56c22351ff844b12f59e5c91993a6d793f098cfb?d=identicon)[Smeagolworms4](/maintainers/Smeagolworms4) --- Top Contributors [![Smeagolworms4](https://avatars.githubusercontent.com/u/4448640?v=4)](https://github.com/Smeagolworms4 "Smeagolworms4 (91 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)") --- Tags apirestdocumentationswaggeropenapigollumsf ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/gollumsf-rest-doc-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/gollumsf-rest-doc-bundle/health.svg)](https://phpackages.com/packages/gollumsf-rest-doc-bundle) ``` ### Alternatives [vyuldashev/laravel-openapi Generate OpenAPI Specification for Laravel Applications 4621.2M](/packages/vyuldashev-laravel-openapi)[tartanlegrand/laravel-openapi Generate OpenAPI Specification for Laravel Applications 38210.9k2](/packages/tartanlegrand-laravel-openapi)[vanderlee/swaggergen Generate Swagger/OpenAPI documentation from simple PHPdoc-like comments in PHP source code. 42131.0k3](/packages/vanderlee-swaggergen)[api-platform/laravel API Platform support for Laravel 58171.6k14](/packages/api-platform-laravel)[noitran/opendox OpenApi(Swagger) 3.0 package for Lumen 5.5+ and Laravel 5.5+ with REDOC UI and SwaggerUI 3 2314.4k](/packages/noitran-opendox) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)