From 7a12dda409bbf5e18e5c7afeeff4f5900ad0f06a Mon Sep 17 00:00:00 2001 From: Nicolas PHILIPPE Date: Wed, 30 Aug 2023 10:30:10 +0200 Subject: [PATCH] docs(content-negociation): document how to declare an encoder for custom format --- core/content-negotiation.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/core/content-negotiation.md b/core/content-negotiation.md index 83bc7cd2cb0..547d65786d8 100644 --- a/core/content-negotiation.md +++ b/core/content-negotiation.md @@ -196,6 +196,19 @@ api_platform: myformat: ['application/vnd.myformat'] ``` +You will also need to declare an encoder which supports the new format: + +```yaml +services: + app.api-platform.myformat.encoder: + class: ApiPlatform\Serializer\JsonEncoder + arguments: + $format: 'myformat' + # The following lines are only needed if autoconfigure is disabled + # tags: + # - { name: 'serializer.encoder' } +``` + API Platform will automatically call the serializer with your defined format name as `format` parameter during the deserialization process (`myformat` in the example). It will then return the result to the client with the requested MIME type using its built-in responder. For non-standard formats, [a vendor, vanity or unregistered MIME type should be used](https://en.wikipedia.org/wiki/Media_type#Vendor_tree).