1 个不稳定版本

0.1.5 2019年9月5日

#55 in #swagger


cargo-rocketapi 中使用

MIT 许可证

115KB
1K SLoC

open api 构建状态 软件许可证

Rust 库,用于序列化和反序列化 open api 文档

文档

安装

将以下内容添加到您的 Cargo.toml 文件中

[dependencies]
openapi = "0.1"

使用方法

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 提供了序列化和反序列化 openapi 规范的结构和支持

示例

典型用法是将现有的规范反序列化到持久化的 Rust 形式,反之亦然

hyper 客户端应配置为使用 tls。

extern crate openapi;

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

错误

操作通常返回一个 openapi::Result 类型,这是 Rust 内置 Result 的别名,其 Err 类型固定为 openapi::errors::Error 枚举类型。这些是通过 error-chain 库提供的,因此它们的形状和行为应与现有的 error_chain 用户一致和熟悉。

依赖项

~6–8MB
~188K SLoC