Expand description
Openapi provides structures and support for serializing and deserializing openapi specifications
§Examples
Typical use deserialing an existing to a persisted spec to rust form or visa versa
The hyper client should be configured with tls.
extern crate openapi;
fn main() {
match openapi::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. These are
provided
using error_chain crate so their
shape and behavior should be consistent and familiar to existing
error_chain users.
Re-exports§
pub use error::Error;
Modules§
- Error types
- Support for OpenApi version 2.0 specification.
- Support for OpenApi version 3.0.1 specification.
Enums§
- Supported versions of the OpenApi.
Functions§
- deserialize an open api spec from a path
- deserialize an open api spec from type which implements Read
- serialize to a json string
- serialize to a yaml string