schemars/docs/_v0/examples/2-serde_attrs.md
2024-06-09 19:01:24 +01:00

777 B

title parent nav_order summary
Using Serde Attributes Examples 2 Deriving JsonSchema on types that use #[serde] attributes to customise serialization behaviour.

Using Serde Attributes

One of the main aims of this library is compatibility with Serde. Any generated schema should match how serde_json would serialize/deserialize to/from JSON. To support this, Schemars will check for any #[serde(...)] attributes on types that derive JsonSchema, and adjust the generated schema accordingly.

The list of supported #[serde] attributes are [documented here]({{ site.baseurl }}{% link 1.1-attributes.md %}#supported-serde-attributes).

{% include example_v0.md name="serde_attrs" %}