Add documentation for StreamedJsonResponse

Author: alexander-schranz

components/http_foundation.rst

@@ -585,6 +585,45 @@ represented by a PHP callable instead of a string::
 
 .. _component-http-foundation-serving-files:
 
+Streaming a JSON Response
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The :class:`Symfony\\Component\\HttpFoundation\\StreamedJsonResponse` class allows
+an API to return a lot of data as JSON and keep the used resources low by make usage
+of Generators.
+
+It expects a JSON structure with one or multiple replacers identifiers, as example
+the `'__articles__'`. As a second argument it requires one or multiple Generators
+which items can be converted to a JSON via ``json_encode`` method. The key of the
+Generators requires to be the used replacer identifiers.
+
+.. code-block:: php
+
+ use Symfony\Component\HttpFoundation\StreamedJsonResponse;
+
+ $response = new StreamedJsonResponse(
+ // json structure with replace identifiers
+ [
+ '_embedded' => [
+ 'articles' => '__articles__',
+ ],
+ ],
+ // array of generators with replace identifier used as key
+ [
+ '__articles__' => (function (): \Generator { // any method or function returning a Generator
+ yield ['title' => 'Article 1'];
+ yield ['title' => 'Article 2'];
+ yield ['title' => 'Article 3'];
+ })(),
+ ]
+ );
+
+.. tip::
+
+ If loading data via doctrine the ``toIterable`` method of ``Doctrine`` can be
+ used to keep also the resources low and fetch only one row one by one.
+ See the `Doctrine Batch processing`_ documentation for more.
+
 Serving Files
 ~~~~~~~~~~~~~
 
@@ -823,3 +862,4 @@ Learn More
 .. _`JSON Hijacking`: https://haacked.com/archive/2009/06/25/json-hijacking.aspx/
 .. _OWASP guidelines: https://cheatsheetseries.owasp.org/cheatsheets/AJAX_Security_Cheat_Sheet.html#always-return-json-with-an-object-on-the-outside
 .. _RFC 8674: https://tools.ietf.org/html/rfc8674
+.. _Doctrine Batch processing: https://www.doctrine-project.org/projects/doctrine-orm/en/2.13/reference/batch-processing.html#iterating-results