oas3 0.22.0

Structures and tools to parse, navigate, and validate OpenAPI v3.1.x specifications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# `oas3`

<!-- prettier-ignore-start -->

[![crates.io](https://img.shields.io/crates/v/oas3?label=latest)](https://crates.io/crates/oas3)
[![Documentation](https://docs.rs/oas3/badge.svg?version=0.22.0)](https://docs.rs/oas3/0.22.0)
[![dependency status](https://deps.rs/crate/oas3/0.22.0/status.svg)](https://deps.rs/crate/oas3/0.22.0)
![MIT or Apache 2.0 licensed](https://img.shields.io/crates/l/oas3.svg)
<br />
[![CI](https://github.com/x52dev/oas3-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/x52dev/oas3-rs/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/x52dev/oas3-rs/graph/badge.svg?token=OpYe6I7dj5)](https://codecov.io/gh/x52dev/oas3-rs)
![Version](https://img.shields.io/crates/msrv/oas3.svg)
[![Download](https://img.shields.io/crates/d/oas3.svg)](https://crates.io/crates/oas3)

<!-- prettier-ignore-end -->

<!-- cargo-rdme start -->

Structures and tools to parse, navigate and validate [OpenAPI v3.1.x] specifications.

Note that due to v3.1.x being a breaking change from v3.0.x, you may have trouble correctly parsing
specs in the older format.

## Example

```rust
let yaml = std::fs::read_to_string("path/to/openapi.yml").unwrap();

match oas3::from_yaml(yaml) {
  Ok(spec) => println!("spec: {:?}", spec),
  Err(err) => println!("error: {}", err)
}
```

## Order Preservation

OpenAPI maps are represented by [`Map`], an order-preserving map type. When a
document is deserialized, map entries keep the order they had in the input
document. When a spec is serialized again, those entries are emitted in that
stored order rather than being sorted by key.

This applies to typed OpenAPI maps, such as paths, component maps, schema
properties, media type maps, responses, callbacks, and specification
extensions. Nested JSON objects inside extension values also preserve order
when the default `preserve-order` feature is enabled.

If a deterministic key-sorted map is needed, convert a [`Map`] into a
[`std::collections::BTreeMap`].

## Crate Features

- `preserve-order`: Enabled by default. Enables `serde_json`'s
  `preserve_order` feature so JSON object order is preserved inside
  [`serde_json::Value`] values, including nested specification extension
  objects. Disabling default features opts out of this `serde_json` feature;
  typed OpenAPI maps still use [`Map`], but arbitrary nested JSON objects in
  extension values may use `serde_json`'s default object ordering.
- `yaml-spec`: Enables YAML parsing and serialization with `yaml_serde`.

[OpenAPI v3.1.x]: https://spec.openapis.org/oas/v3.1.1

<!-- cargo-rdme end -->