[Serializer] [JsonStreamer] Add streaming JSON documentation

[mtarld]

Fixes #20461, #20708, #20676, #20598, #20572

[mtarld]

The remaining failure is due to the fact that the https://github.com/symfony-tools/symfony-application application does not have the src/Encodable folder.

Should we create it? Or should we add the issue to the baseline? Or maybe commenting that configuration?

[wouterj]

Hi @mtarld. Thanks a lot for starting this and providing so much valuable documentation early in the development phase!

Before reviewing the whole document, we must think about the position of the component in the documentation. We've mostly stopped using the components/ directory. Instead, we focus on the "guides" and document framework usage. This component is a bit more challenging, as it belongs to the "Serialization" topic that currently belongs to the Serializer component. We've discussed this a bit with the core team during the SymfonyCon:

I think the best way would be to move this article to serializer/json_encoder.rst, and add a little section at the start of serializer.rst mentioning this component and when you should use instead of the Serializer component (e.g. a compact version of the "Serializer or JsonEncoder?" section). But we're of course open if people have better ideas on how to position this new component in the ecosystem!

---

Something that might also be interesting is adding a php-standalone tab to some of the code examples, showing how to use this component standalone. You can see this in use in the main serializer.rst for instance.

[SirRFI]

The documentation requires update, because the component and it's contents has been renamed - see symfony/symfony#59863

[SirRFI]

Can you provide minimum code required to use the component in custom service inside Symfony project? Could be also useful for "New in Symfony 7.3" blog series.

I tried following the documentation (with updated names), but I get Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException: You have requested a non-existent service "Symfony\Component\JsonStreamer\StreamReaderInterface". despite it's visible in bin/console debug:container. Also tried json.stream_reader alias. All Symfony dependencies are updated to 7.3.*-dev.

[mtarld]

Hey @SirRFI , thanks for keeping track of it. I'm aware of these points yes! 🙂

I'm really busy these days, but as soon as I have time, I'll update this PR (containing your suggestions) - it's part of my top priorities.