Download
The NelmioApiDocBundle bundle allows you to generate documentation in the OpenAPI (Swagger) format and provides a sandbox to interactively experiment with the API. This bundle supports Symfony route requirements, PHP annotations, Swagger-Php annotations, FOSRestBundle annotations, and apps using API-Platform. For models, it supports the Symfony serializer, the JMS serializer and the willdurand/Hateoas library. It does also support Symfony form types. It generates OpenAPI documentation from your Symfony app thanks to Describers. One extracts data from SwaggerPHP annotations, one from your routes, etc. You can configure global information in the bundle configuration documentation.info section. Open a command console, enter your project directory and execute the provided command to download the latest version of this bundle.
Features
- The normal PHPdoc block on the controller method is used for the summary and description
- A model can be a Symfony form type, a Doctrine ORM entity or a general PHP object
- You can customize the documentation of a form field using the documentation option
- Customize the documentation of an object's property
- Browse your documentation with Swagger UI
- Expose it in JSON
Project Samples
