nelmio/NelmioApiDocBundle
Stars: 2153
Forks: 828
Pull Requests: 1026
Issues: 1094
Watchers: 65
Last Updated: 2023-09-16 15:54:11
Generates documentation for your REST API from annotations
License: MIT License
Languages: PHP, JavaScript, Shell, CSS, Batchfile, Twig
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Migrate from 3.x to 4.0
To migrate from 3.x to 4.0, follow our guide.
Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.
Migrate from 2.x to 3.0
To migrate from 2.x to 3.0, follow our guide.
Installation
Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:
composer require nelmio/api-doc-bundle
Documentation
Read the documentation on symfony.com
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dependencies:
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update
Then run the test suite:
./phpunit
License
This bundle is released under the MIT license.
OPEN ISSUES
See all- Support for fractal transformers by @Nyholm
- Translations using translation_domain are not parsed by @Sydney-o9
- How to allow multiple Response content types from FOSRestBundle Configuration by @0xMatt
- Add Support for JMS Serializer Inlined Properties by @GrzegorzW
- Provide autowiring for ApiDocGenerator by @soullivaneuh
- Symfony form in GET-request by @nadrshin
- Add Support for Annotations on Getter Methods by @florianajir
- [RFC] Allow to define parameters of swagger ui by @magnetik
- Problems with FOSUserBundle - Property "AppBundle\Entity\User:roles" is an array by @StefanGla
- Fos Rest FileParam Not Recognized by @nachocifu
- @Rest/Groups Serialization Annotation Supported? by @nachocifu
- No documentation generated for non persisted column by @darame07
- Serialization groups are not passed on to nested Entities by @chriskaya
- Merge Parent and Child Property OpenAPI Annotation/Attribute Configuration by @Gabb1995
- Better Document How the Form Model Describer Works by @aequasi
- More Advanced Area Filtering Based on `@Areas` Annotations and Config by @ThomasLabstep
- Entity helper recognized as accessor by @fmarchalemisys
- Documentation for versioned api by @MatGor7
- JMS Serializer Describer Does Not Respect Default Group by @StefanNiederkofler
- Symfony's UserInterface roles variable by @Terroraapje
- Bug in ApiPlatformDescriber by @helmut-hoffer-von-ankershoffen
- Support Model Describers for `ramsey/uuid` by @DenisMir
- The PropertyInfo component was not able to guess the type of Doctrine\Common\Collections\Collection::$element by @Taronyuu
- Allow Model Name Generation to be Extensible by @leroy0211
- Form properties are not displayed as snake case by @lukepass
- Add Redoc ui support by @GuilhemN
- [Proposition] Support for many Yaml files with documentation by @vertisan
- @JMS\VirtualProperty not working when using @JMS\Groups by @lukepass
- [feature] Leverage readOnly/writeOnly metadata by @GuilhemN
- [4.0] "Try out" possible without filling required parameters by @NicoHaase
- Use of default PHP property values as default/example property values by @DusanKasan
- Allow custom key usage in "documentation" (for example x-logo) by @BafS
- The option "documentation" does not exist by @pmoscicki
- Allow model alternative names inside the model class by @andreskrey
- Allow custom item types handling in JMSModelDescriber by @kadet1090
- Cannot include schema from sources other than external by @hubertnnn
- [v4.1.1] Areas not working as expected by @michanismus
- Favor OpenAPI Annotations Over FOSRestBundle Annotations by @jlekowski
- Groups is not used for Model naming in array property of object by @arneee
- API versioning with FOSRest by @zys-gd
- EntityType field type renders as entire namespace instead of just the class name by @DoobleD
- Problem due to fix of #1756 by @tteze
- Issues to reference a component from a controller by @Frc-dev
- JMS XML Annotations are somewhat ignored in the UI by @MatthewBooth
- Multiple Definitions for @OA\Get->path Warning leads to Symfony ErrorException by @c-schinzer
- How to register custom processor? by @DJZT
- Should Route Requirements be Surround with `^...$` in Path Schema Patterns? by @chrisguitarguy
- [RFC] [3.x] Allow `FosRestDescriber` to extract the serialization groups from `FOS\RestBundle\Controller\Annotations\View` annotation by @phansys
- Query param of FOSRest with Symfony Constraint causes error in SwaggerUI by @eric-boot
- Symfony serializer groups by @pkly
- POST method error only with nelmio api/doc page when functional with Postman by @leCheveuCodeur
- Use swagger.yaml for API response definition instead of model/entity class by @RalphPungaKronbergs
- Ability to add title/description to custom models by @Seldaek
- Referenced parameters are not added to reqeuest by @sweoggy
- Integration with Api-Platform by @AngelidisChris
- Best way to get the schema of a single endpoint? by @LuigiCardamone
- [Maintainance] Looking for additional maintainers by @GuilhemN
- How to annotate key value response by @demianchuk
- use attributes instead of groups by @SakhriHoussem
- Form fields are gone in "try it out" section after nelmio/api-doc-bundle (v3.2.1 => v3.10.1) upgrade by @umpirsky
- Automatic inference of schema based on return types and ParamConverters by @melvinkoopmans
- Attributes plain object error by @Gemorroj
- [RFC] Target newer PHP & symfony version by @magnetik
- Combine @OA\Model with @OA\AdditionalProperties by @Herz3h
- #[PathParameter] could get parameter type from PHP argument type hint by @mathroc
- Preserve auth token in localStorage by @beeyev
- Missing #[Parameter] attribute support by @mathroc
- OA\Property as attribute doesn't work, annotation does by @arjanfrans
- Using @Model inside @OpenApi\Attributes\RequestBody::$ref is not allowed by @enumag
- Path not resolved from Route when using attributes by @enumag
- Support Ignoring Parent Class Properties When Generating Schemas by @chrisguitarguy
- Unable to render a Form Model to show the 400 Bad Request response? by @DavidGarciaCat
- Using disable_default_routes filters out routes using attributes by @JohnstonCode
- Upgrading 3.x to 4.x error by @fernandosngular
- Nested objects properties are not displayed by @geoffroyp
- "Area default is not supported as it isn't defined in config" when using setAllowedTypes in forms by @lukepass
- PHPStan error when using Model in Response attribute by @lucasmirloup
- Schema of type "\App\Entity\TranslationInterface" can't be generated, no describer supports it. by @webspin
- Symfony's auto-generated PHP Config class NelmioApiDocConfig seems unusable (or I didn't understood how at least) by @gnutix
- Multiple definitions for @OA\Post()->responses Using: Skipping: by @MrBelbedair
- How to reuse an entire response shape using definitions and ref in 3.x? by @gremo
- Hot to generate "x-auth-type"? by @gh21usr
- Indirect deprecations due to zircote/swagger-php 4.5.0 by @schodemeiss
- [feature] Dinamic configure the serializer for model. Really? by @atlance
- Property "App\Model\Custom\Modules::globalScopes" is an array, but its items type isn't specified. You can specify that by using the type `string[]` for instance or `@OA\Property(type="array", @OA\Items(type="string"))`. by @gfriessner
- Unable to specify server_url and servers urls by @arturssmirnovs
- Larger data crashing the browser by @igordeveloper
- Incompatibility with DoctrineBundle v2.8 by @webinarium
- Property type 'array' is deprecated what shold I use instead? by @rizhenkov
- RenderOpenApi::__construct(): Argument #1 ($generatorLocator) must be of type Psr\\Container\\ContainerInterface, Nelmio\\ApiDocBundle\\ApiDocGenerator given by @j-wbrown
- Doc not rendering private/protected properties from traits by @jmsariron
- Connect the OpenAPI Context with Loggers from Symfony by @chrisguitarguy
- additionalProperties: false for schema based on Doctrine entity by @p-golovin
- Enum: Items as enum string problem by @webspec2012
- Property type array attribute does not work, annotation does by @bazo
- Not possible to change the name in additionalProperties in rendered swagger-ui example by @nnikitos95
- Form, formEvent and Model ? by @ShinoOoesu
- Decoupling OpenAPI Attributes from Controller Actions in Symfony 5.4 for Cleaner Code by @mrnavrc
- Symfony date constraint generate unexpected Open API Specification by @alxvgt
- Reduce the quantity of logs generated by name collisions by @emhovis
- Set-Cookie header of responses are not shown for test calls in the swagger UI by @stollr
- Add support for Backed Enum as model in Symfony Forms by @nikola-jovanovic-php
- Clarification array in-query parameter by @ar3s
- Empty site with examble config by @Adi-18
- Generating required fields while using DTOs in response by @mrazek-honza
- Allow the use of namespace as the Model name by @acrsouza
RELEASES
See all- 2.4.0 (2013-11-14) by @willdurand
- 2.5.0 (2014-02-11) by @willdurand
- 2.5.1 (2014-03-12) by @willdurand
- 2.5.2 (2014-05-16) by @willdurand
- 2.6.0 (2014-06-25) by @willdurand
- 2.7.0 (2014-07-30) by @willdurand
- 2.8.0 (2015-03-06) by @willdurand
- 2.9.0 (2015-05-16) by @willdurand
- 2.10.0 (2015-10-23) by @willdurand
- 2.10.1 (2015-10-27) by @willdurand
- 2.10.2 (2015-10-27) by @willdurand
- 2.10.3 (2015-10-28) by @willdurand
- 2.11.0 (2015-12-04) by @willdurand
- 2.11.1 (2015-12-08) by @willdurand
- 2.11.2 (2016-01-04) by @willdurand
- 2.12.0 (2016-03-21) by @willdurand
- 2.13.0 (2016-06-13) by @willdurand
- by @GuilhemN
- improved sandbox by @lsmith77
- Symfony 5.0 support + Property Describers by @GuilhemN
- First beta for v4.0.0 and its OpenApi 3.0 support! by @GuilhemN
- Version 3.7 release! by @GuilhemN
- Second beta of NelmioApiDocBundle version 4! by @GuilhemN
- Final version of 4.0! by @GuilhemN
- Adds php 8 support and extends the documentation of form types with the support of `@SWG\Definition` by @GuilhemN
- Adds php 8 support and extend the documentation of form types with the support of `@OA\Schema` by @GuilhemN
- Add compound constraints support by @GuilhemN
- Log model name conflicts, and fix deprecations by @GuilhemN
- Allow to dump a static archive with the API documentation by @GuilhemN
- Fix support of apps without twig by @GuilhemN
- Fix several deprecations by @GuilhemN
- Add Symfony 6 support and php 8.1 attributes by @GuilhemN
- revert commit introducing memory leak by @GuilhemN
- Fix api-platform support and tests by @GuilhemN
- v4.11.1 by @GuilhemN
- v4.11.0 by @GuilhemN