VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add examples to docs

Browse source
This commit is contained in:
Graham Esau 2019-12-26 21:34:08 +00:00
parent d67abbdbb1
commit f387a0ec56
11 changed files with 223 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/examples/2-serde_attrs.md Normal file
View file

@ -0,0 +1,15 @@
---
layout: default
title: Using Serde Attributes
parent: Examples
nav_order: 2
summary: '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](https://github.com/serde-rs/serde). Any generated schema *should* match how [serde_json](https://github.com/serde-rs/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 }}/deriving/attributes/#supported-serde-attributes).
{% include example.md name="serde_attrs" %}