6 releases

Uses old Rust 2015

0.1.5 Apr 30, 2017
0.1.4 Apr 26, 2017

#55 in #swagger

Download history 38/week @ 2024-11-20 88/week @ 2024-11-27 144/week @ 2024-12-04 212/week @ 2024-12-11 302/week @ 2024-12-18 271/week @ 2024-12-25 206/week @ 2025-01-01 281/week @ 2025-01-08 206/week @ 2025-01-15 171/week @ 2025-01-22 184/week @ 2025-01-29 103/week @ 2025-02-05 98/week @ 2025-02-12 155/week @ 2025-02-19 170/week @ 2025-02-26 185/week @ 2025-03-05

625 downloads per month
Used in 2 crates (via service_policy_kit)

MIT license

94KB
190 lines

open api Build Status

Rust crate for serializing and deserializing open api documents

Documentation

install

add the following to your Cargo.toml file

[dependencies]
openapi = "0.1"

usage

extern crate openapi;

fn main() {
  match openapi::from_path("path/to/openapi.yaml") {
    Ok(spec) => println!("spec: {:?}", spec),
    Err(err) => println!("error: {}", err)
  }
}

Doug Tangren (softprops) 2017


lib.rs:

Openapi provides structures and support for serializing and deserializing openapi specifications

Examples

Typical use deserialing an existing to a persisted spec to rust form of 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.

Dependencies

~3.5–9.5MB
~112K SLoC