docs: Document custom types #3603
Open
+214
−3
Conversation
This file contains 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
github-actions
bot
added
area/docs
JacobCoffee
reviewed
Jun 27, 2024
provinzkraut
requested changes
Jun 27, 2024
docs/usage/custom-types.rst
Outdated
|
|
||
| Data serialization / deserialization (encoding / decoding) and validation are important parts of any API framework. | ||
|
|
||
| Among others, litestar supports Python's builtin dataclasses, Pydantic and msgspec for these tasks, defaulting to msgspec with json as serialization protocol. |
There was a problem hiding this comment.
I don't think "defaulting to msgspec" is the correct phrasing here. Litestar only uses msgspec for serialisation to JSON. It can integrate with Pydantic and others, but doesn't use those to encode anything to JSON directly; It all goes through msgspec eventually.
I'm not sure msgspec needs to be mentioned in this part of the documentation in general, as it's more of an implementation detail. We should mention that that's how it works, but perhaps we can find a better place for that
Co-authored-by: Jacob Coffee <[email protected]>
added 2 commits
June 28, 2024 14:44
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3603 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
type_decodersandtype_encodersin order to allow litestar to en/decode custom types via msgspec