Generates OpenAPI documentation for Symfony REST APIs using PHP 8 attributes.
NelmioApiDocBundle is a Symfony bundle that automatically generates OpenAPI documentation for REST APIs by parsing PHP 8 attributes in your code. It solves the problem of maintaining accurate API documentation by keeping it synchronized with your actual implementation through code annotations.
Symfony developers building RESTful APIs who need automated, standards-compliant documentation generation integrated into their Symfony projects.
Developers choose NelmioApiDocBundle because it provides seamless Symfony integration with zero manual documentation effort, generates interactive OpenAPI specs with Swagger UI, and ensures documentation accuracy through direct code extraction.
Generates documentation for your REST API from attributes
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Uses PHP 8 attributes to embed API definitions directly in controllers and models, ensuring documentation stays synchronized with implementation as per the project philosophy of reducing maintenance overhead.
Leverages Symfony's serializer and validator components to automatically detect request/response models and validation rules, minimizing manual configuration for common use cases.
Includes a built-in Swagger UI interface, allowing developers to test and explore API endpoints directly from the generated documentation without external tools.
Integrates tightly with Symfony's routing, validation, and serialization systems, requiring minimal setup and configuration for Symfony-based projects.
Version 5.0 dropped support for annotations in favor of PHP 8 attributes, requiring significant codebase updates as highlighted in the migration guides, which can be disruptive for existing projects.
Requires PHP 8.1 or higher and Symfony 6.4 or above for version 5.x, limiting adoption in environments with older technology stacks or slower upgrade cycles.
Tied exclusively to the Symfony ecosystem, making it unsuitable for projects that might migrate to other frameworks or need framework-agnostic documentation solutions.