Update MSRV to 1.56
This commit is contained in:
parent
386e3d7f5a
commit
e0495c0c87
6 changed files with 111 additions and 36 deletions
35
README.md
35
README.md
|
@ -3,7 +3,7 @@
|
|||
[](https://github.com/GREsau/schemars/actions)
|
||||
[](https://crates.io/crates/schemars)
|
||||
[](https://docs.rs/schemars)
|
||||
[](https://blog.rust-lang.org/2020/07/16/Rust-1.45.0.html)
|
||||
[](https://blog.rust-lang.org/2021/10/21/Rust-1.56.0.html)
|
||||
|
||||
Generate JSON Schema documents from Rust code
|
||||
|
||||
|
@ -39,10 +39,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "MyStruct",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"my_bool",
|
||||
"my_int"
|
||||
],
|
||||
"required": ["my_bool", "my_int"],
|
||||
"properties": {
|
||||
"my_bool": {
|
||||
"type": "boolean"
|
||||
|
@ -67,9 +64,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
"anyOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"StringNewType"
|
||||
],
|
||||
"required": ["StringNewType"],
|
||||
"properties": {
|
||||
"StringNewType": {
|
||||
"type": "string"
|
||||
|
@ -79,15 +74,11 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
},
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"StructVariant"
|
||||
],
|
||||
"required": ["StructVariant"],
|
||||
"properties": {
|
||||
"StructVariant": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"floats"
|
||||
],
|
||||
"required": ["floats"],
|
||||
"properties": {
|
||||
"floats": {
|
||||
"type": "array",
|
||||
|
@ -106,11 +97,12 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Serde Compatibility
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
```rust
|
||||
use schemars::{schema_for, JsonSchema};
|
||||
|
@ -145,10 +137,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "MyStruct",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"myBool",
|
||||
"myNumber"
|
||||
],
|
||||
"required": ["myBool", "myNumber"],
|
||||
"properties": {
|
||||
"myBool": {
|
||||
"type": "boolean"
|
||||
|
@ -178,9 +167,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
},
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"floats"
|
||||
],
|
||||
"required": ["floats"],
|
||||
"properties": {
|
||||
"floats": {
|
||||
"type": "array",
|
||||
|
@ -196,6 +183,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
`#[serde(...)]` attributes can be overriden using `#[schemars(...)]` attributes, which behave identically (e.g. `#[schemars(rename_all = "camelCase")]`). You may find this useful if you want to change the generated schema without affecting Serde's behaviour, or if you're just not using Serde.
|
||||
|
@ -257,14 +245,17 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Feature Flags
|
||||
|
||||
- `derive` (enabled by default) - provides `#[derive(JsonSchema)]` macro
|
||||
- `impl_json_schema` - implements `JsonSchema` for Schemars types themselves
|
||||
- `preserve_order` - keep the order of struct fields in `Schema` and `SchemaObject`
|
||||
|
||||
Schemars can implement `JsonSchema` on types from several popular crates, enabled via feature flags (dependency versions are shown in brackets):
|
||||
|
||||
- `chrono` - [chrono](https://crates.io/crates/chrono) (^0.4)
|
||||
- `indexmap1` - [indexmap](https://crates.io/crates/indexmap) (^1.2)
|
||||
- `either` - [either](https://crates.io/crates/either) (^1.3)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue