[−][src]Crate oas3
Structures and tools to parse, navigate and validate OpenAPI v3 specifications.
Example
match oas3::from_path("path/to/openapi.yaml") { Ok(spec) => println!("spec: {:?}", spec), Err(err) => println!("error: {}", err) }
Errors
Operations typically result in a openapi::Result
Type which is an alias for Rust's built-in
Result with the Err Type fixed to the [openapi::errors::Error
] enum type.
Modules
conformance | |
validation | Data validation (JSON only) |
Structs
Schema | The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema. |
Spec | top level document |
Enums
Error | Top-level Errors |
Functions
from_path | deserialize an open api spec from a path |
from_reader | deserialize an open api spec from type which implements Read |
to_json | serialize to a json string |
to_yaml | serialize to a yaml string |
Type Definitions
OpenApiV3Spec | Version 3.0.1 of the OpenApi specification. |