softprops / openapi Goto Github PK

View Code? Open in Web Editor NEW

126.0 6.0 61.0 1.13 MB

openapi schema serialization for rust

License: MIT License

Rust 100.00%

openapi rust-library

openapi's Introduction

open api

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

openapi's People

Contributors

Stargazers

Watchers

openapi's Issues

Support for OpenAPI 3.0

These are the changes:
https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/

I'm having a lot of trouble with parsing yaml files.
But, it's really difficult to determine where the error lies.
All I get is:
error: Yaml(Message("data did not match any variant of untagged enum OpenApi", None))
I've trace'd it, I even created a Manual Deserializer.
It parses the top level, but has problems with a sub-level parsing (in "components").

Is there a way to get it to generate a better error.
At least the token it barfs on ?

Thanks
JR

implement a more complete security definition object

it doesn't represent much atm

Publish OpenApi 3.0

Crate version 0.1.5 does not include OpenApi 3.0 support, though it looks like the code for it has already been written. Can this be published?

is it still maintained?

Better ergonomics for Operations

I've started working on code based on this library and working with Operations is difficult I want to do something like:

for operation in operations {
  ...
}

But each operation is a different field in the structure, I do not know if it's possible to iterate them in Rust

Support for vendor extensions

Support keys in the format x-vendorextension. I believe these can be written at any level so maybe is a challenge to do with Serde

look into enum-erating what's currently represented as string values

OpenApi v3.1 compatibility ?

Is there a plan to support v3.1 ? https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md

I would need such parser and I would be willing to contribute it here as a PR.

Serde 0.9

https://github.com/serde-rs/serde/releases

fix tests on master

It seems since the initial work on openapi v3 was introduced there has not been any clean up of failing tests. Some work was done in #25 (comment) to help surface errors more clearly to iterate on fixing them but it was out of scope of that pull to fix all the failing tests. lets open a separate pull that focuses mainly on get tests to pass so we can ship #22

Support for $ref part 2

Support for $ref as text was added before. But ideally these $ref are deserialized into pointers to other structs or something like that.
The deserialization should fail if the ref does not point to any known point.
To validate if a ref exist in the doc I'm doing this really really terrible code:
https://github.com/JordiPolo/oatool/blob/master/src/main.rs#L26

If real support is added, then all this code disappears as a non-proper ref would cause deserialization error.

---- test_basic_structure stdout ----
thread 'test_basic_structure' panicked at 'Couldn't deser doc: Yaml(Message("data did not match any variant of untagged enum OpenApi", None))', src/lib.rs:34:15
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Here is the code I used to generate the error:

#[test]
fn test_basic_structure() {
    use std::io::{self, Cursor};

    let doc = r#"swagger: "2.0"
info:
  title: Sample API
  description: API description in Markdown.
  version: 1.0.0

host: api.example.com
basePath: /v1
schemes:
  - https

paths:
  /users:
    get:
      summary: Some text
      description: Some more text
      produces:
        - application/json
      responses:
        200:
          description: OK"#.to_string();

    let bytes = doc.as_bytes().to_vec();
    let mut bytes = Cursor::new(bytes);

    let api = openapi::from_reader(&mut bytes).expect("Couldn't deser doc");
}