6 releases

Uses old Rust 2015

0.1.5 Apr 30, 2017
0.1.4 Apr 26, 2017

#51 in #swagger

Download history 202/week @ 2023-10-19 117/week @ 2023-10-26 83/week @ 2023-11-02 102/week @ 2023-11-09 92/week @ 2023-11-16 91/week @ 2023-11-23 80/week @ 2023-11-30 79/week @ 2023-12-07 62/week @ 2023-12-14 71/week @ 2023-12-21 85/week @ 2023-12-28 129/week @ 2024-01-04 97/week @ 2024-01-11 82/week @ 2024-01-18 75/week @ 2024-01-25 77/week @ 2024-02-01

350 downloads per month
Used in 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–5.5MB
~116K SLoC