docs(performance): document JSON streaming via JsonStreamer#2298
Merged
Conversation
Available since 4.2 but undocumented. Covers symfony/json-streamer install, enable_json_streamer config, and the jsonStream attribute on resources/operations (json + jsonld formats). Refs api-platform/core#7225
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the JSON streaming feature available since API Platform 4.2 (introduced in api-platform/core#7225) but so far undocumented.
Adds a
## JSON Streamingsection tocore/performance.mdcovering:JsonStreamercomponent to stream responses viaStreamedResponseinstead of building the full serialized payload in memory.composer require symfony/json-streamer, Symfony 7.4+ (experimental component).enable_json_streamerconfig (auto-enabled when the component is installed).jsonStream: true.jsonandjsonldformats; falls back to the Serializer otherwise.Refs api-platform/core#7225