FriendsOfSymfony/FOSRestBundle
Stars: 2779
Forks: 721
Pull Requests: 1268
Issues: 1124
Watchers: 85
Last Updated: 2023-07-20 08:28:17
This Bundle provides various tools to rapidly develop RESTful API's with Symfony
License: MIT License
Languages: PHP, Twig, Python
http://symfony.com/doc/master/bundles/FOSRestBundle/index.html
FOSRestBundle
This bundle provides various tools to rapidly develop RESTful API's & applications with Symfony. Features include:
- A View layer to enable output and format agnostic Controllers
- Accept header format negotiation including handling for custom mime types
- RESTful decoding of HTTP request body and Accept headers
- Map exception codes to HTTP response status codes
- A serializer error renderer that returns exceptions and errors in a format compatible with RFC 7807 using the Symfony Serializer component or the JMS Serializer
Documentation
Please see the upgrade files (UPGRADING-X.X.md) for any relevant instructions when upgrading to a newer version.
Installation
All the installation instructions are located in the documentation.
License
This bundle is under the MIT license. See the complete license in the bundle.
OPEN ISSUES
See all- look into how best way to support streaming responses by @lsmith77
- optionally automatically redirect on invalid query params by @lsmith77
- @QueryParam default value from the PHP code directly by @dewos
- AccessDeniedListener doesn't set correct header on 401 status code by @mdarse
- ParamFetcher parameter conflicts with a path parameter 'page' for route 'route_name' by @marcj
- add link resources on REST with symfony stack by @cordoval
- Discussion about the AccessDeniedListener and 401, as defined in RFC 2616 by @SimonSimCity
- Clarify Body Listener Usage in Documentation by @jonmchan
- The BodyListener does not accept scalars even though they are properly encoded by @nail
- Issue with View handler by @ama3ing
- Invalid json handling of empty objects {} converted to empty arrays [] by @joshribakoff
- Body empty when using multipart request by @roelveldhuizen
- allowBlank not documented in possible annotation parameter for QueryParam / RequesParam by @allan-simon
- Supporting HTTP Multipart Batched Request by @SimonSimCity
- Sending a form in an array to a view wipes the other messages by @Azenet
- Param Fetcher - Name with dot by @matiux
- Disable CSRF on a "context" basis by @jbenezech
- rule stop:true does not bypass FOSRestBundle by @mpbzh
- Form validation: NotBlank assert does not specify fields. by @soullivaneuh
- Allow form media type for POST on body converter by @soullivaneuh
- Provide a BooleanType by @fsevestre
- [DX] How to handle POST/PUT for entity choices by @allan-simon
- Using RequestBodyParamConverter with get parametr. by @MaxBoltik
- Use the container to resolve our values by @GuilhemN
- array_key_exists error for enity POST with ManyToOne relation by @soullivaneuh
- Update one/few fields with patch action ? by @Jerome1337
- When setting a default parameter to null, '' is set instead by @Ovski4
- FOSRestBundle Security Exception Listener by @DestefanoHub
- Remove memory leak in the ParameterBag (annotations cached between requests) by @GuilhemN
- Feature Request: Ability to configure default behaviour for strict on ParamFetcher by @araines
- Incorrect Content-Type header on PHP errors by @bblue
- Request array using API by @ghost
- Format Listener schould omit content-type header on empty content by @akomm
- Format Listener should return 406 with no content when fallback_format is not defined instead of falling back to text/html by @akomm
- BodyListener should check for supported content-type before checking if request is decodable by @JornEngelbart
- BodyListener is applied to all routes, not only the REST routes by @JornEngelbart
- escape malformed UTF-8 characters by @franek
- Introduction of Manipulative Param Converters by @maennchen
- Groups Annotations don't works by @doums
- FOSRestBundle not returning all roles (missing ROLE_USER) by @qweluke
- Make RequestBodyParamConverter dependent on the zone as well by @zluiten
- Ability to disable fos rest array normalization for certain paths by @koemeet
- FOS rest-bundle + sonata media-bundle by @mustapha72
- validation datetime by @Grazulex
- ParamFetcher: return empty array if no params by @NikitaKharkov
- ParamFetcher: deny all params except list of declared params in queryParam annotations by @NikitaKharkov
- Bug: Warning: array_merge(): Argument #1 is not an array by @yarcowang
- Argument 1 passed to FOS\\RestBundle\\Serializer\\Normalizer\\FormErrorHandler::adaptFormArray() must be an instance of ArrayObject, array given by @NadaBen
- MaxDepth with Symfony Serializer (not JMS) by @sbruev
- Decouple the serialize method and add by @sbruev
- Request Body Converter with Param Converter by @FlorinAsavoaie
- Unable to serialize php Generator (yield) by @sarramegnag
- BodyListener and big files by @Adirelle
- overwrite JMS's ExceptionHandler (FOS\RestBundle\Serializer\Normalizer\ExceptionHandler) by @ebeem
- Unexpected Empty Response by @pdugas
- @QueryParam should allow people to overwrite error message when using Symfony constraints by @tinntsea
- Profiler in tests is null when throwing and exception and using the param_fetcher_listener by @michaelzangerle
- config format_listener->rules with attributes param leads to 406 on SF2.8 and FOSRest 2.0 by @mikelohmann
- Annotation for Serialization groups for specific paths doesn't work by @rokisb
- [Suggestion] Enhancing RequestBody to handle FormData (files + request) by @ancyrweb
- symfony 3.3.6 autowiring happens before JMSHandlersPass removes unused exception_normalizer.jms by @karser
- PUT Controller - ConstraintViolationList as parameter detect the constraint uniqueEntity - No Form by @JuanLuisGarciaBorrego
- Exception normalizers do not work by @miholeus
- Body Converter in RestController breaks DI if SensioExtraFramework auto_convert = true by @JoergSommer
- way to define a own VersionResolver by @Hanmac
- testExceptionExists function needs to be friendly with \Throwable by @Arkemlar
- Exception messages localization by @vpArth
- How to add my own DecoderInterface? by @Spider84
- Problem with versioning not working by @eiosca
- [Question best practice] How do you handle invalid input type in forms? by @acorbel
- RequestBodyParamConverter tries to convert GET requests by @MichaelHindley
- Accept JSON header with charset not accepted by @lgraubner
- Using FOS\RestBundle\Controller\Annotations\View throws exception in Symfony 4 by @matigda
- Partial update with RequestBodyParamConverter by @ThomasLabstep
- Checkbox submit always assume "true" values by @ralmeidaLink
- @RequestParam not working, symfony 4 by @sbahr001
- Need to set `serialize_null` both on FOSRest and JMSSerializer for it to work by @Danita
- Log json_decode errors by @soullivaneuh
- Repeated Use of SubResource Controller by @pdugas
- Populating param entity by @kanonhian
- Form fields to JSON by @Oviglo
- Difference between nullable and strict ? by @TheKassaK
- Pager Fanta && Serializer Group not working by @lmasforne
- No content for OPTIONS requests by @hpatoio
- Add Headers to response by @nicraMarcin
- SF 3.2->3.4 Response 204 regression by @gnat42
- Symfony 4.1 does not log exception error by @votanlean
- Override ViewHandler by @emulienfou
- Symfony 4 REST API - Validation by @MarcelMC
- param fetcher convert integer query parameters to strings by @hatemBBN
- Symfony 4 - mapping data to entity with relations by @NickOver
- $form->isValid() return fals, but form->geterrors() return empty array by @NickOver
- Handle constructor with Symfony serializer by @soullivaneuh
- Serialize form with a CollectionType as an array not as object by @hugoalexmartins
- Bug with camel_keys normalizer and forms by @lukepass
- Handle FOSRestBundle with JMSSerializer and POST params by @suiXz
- Additional LF LF when returning BinaryFileResponse by @litepl
- Strip unprovided parameters from returned data ->all() by @imbue
- FormatListener does not choose the most specific media type from Accept header by @jcorre-hipay
- Invalid status code when form errors by @robinvdvleuten
- Array normalizer and file upload by @lukepass
RELEASES
See all- 0.13.0 by @lsmith77
- fix issu with jsonp view handler service visibility by @lsmith77
- 1.0.0-RC1 by @lsmith77
- 1.0.0-RC2 by @lsmith77
- 1.0.0 by @lsmith77
- 1.1.0 by @lsmith77
- 1.2.0 by @lsmith77
- 1.2.1 by @lsmith77
- 1.2.2 by @lsmith77
- 1.3.0 by @lsmith77
- 1.3.1 by @lsmith77
- 1.4.0-RC1 by @lsmith77
- 1.4.0 by @lsmith77
- security release by @lsmith77
- 1.4.2 by @lsmith77
- 1.5.0-RC1 by @lsmith77
- 1.5.0-RC2 by @lsmith77
- 1.5.0-RC3 by @lsmith77
- 1.5.0-RC4 by @lsmith77
- 1.5.0-RC5 by @lsmith77
- 1.5.0 by @lsmith77
- various minor bug fixes by @lsmith77
- fixed regression with nullable arrays with QueryParam validation by @lsmith77
- fixed issue with the ExceptionController when not using JMS serializer by @lsmith77
- dropped Symfony 2.2 support, improved support for 2.7, bug fixes and various minor features by @lsmith77
- fixed some minor regressions in the config handling in RC1 by @lsmith77
- fixes regressions with ParamConverter, Mimetype and Version Listener by @lsmith77
- fixed a bug with route prefix being ignored as well as a 1.6.0 regression by @lsmith77
- fix regression with handling of methods in Route annotations by @lsmith77
- several bug fixes and doc tweaks by @lsmith77
- make the Bundle compatible with Symfony 3.0 by @lsmith77
- minor tweaks to travis and composer by @lsmith77
- fix problem with camel case serialization and login form #1009 by @GuilhemN
- Fix issues by @GuilhemN
- Bugs fixes and performance improvements by @GuilhemN
- On the way to 2.0 ! by @GuilhemN
- 2.0 is on its way ! by @GuilhemN
- Bug fixes by @GuilhemN
- 1.8.0-BETA2 by @xabbuh
- 2.0.0-BETA3 by @xabbuh
- 1.7.9 by @xabbuh
- Last minor version before the next major ! by @GuilhemN
- by @GuilhemN
- Small fixes by @GuilhemN
- 2.3.0 by @xabbuh
- 2.3.1 by @xabbuh
- 2.5.0 by @xabbuh
- 2.6.0 by @xabbuh
- 2.7.0 by @xabbuh
- 2.7.1 by @xabbuh
- 2.7.2 by @xabbuh
- 2.7.3 by @xabbuh
- 2.7.4 by @xabbuh
- 2.8.0-beta1 by @xabbuh
- 3.0.0-beta1 by @xabbuh
- 2.8.0-beta2 by @xabbuh
- 3.0.0-beta2 by @xabbuh
- 2.8.0-beta3 by @xabbuh
- 3.0.0-beta3 by @xabbuh
- 2.8.0 by @xabbuh
- 3.0.0 by @xabbuh
- 2.8.1 by @xabbuh
- 3.0.1 by @xabbuh
- 2.8.2 by @xabbuh
- 3.0.2 by @xabbuh
- 2.8.3 by @xabbuh
- 3.0.3 by @xabbuh
- Add php 8 support by @GuilhemN
- 3.1.0 by @goetas
- 3.1.1 by @goetas
- 3.2.0 by @goetas
- 3.2.1 by @goetas
- 3.3.0 by @goetas
- 3.4.0 by @goetas
- 3.5.0 by @goetas