More...

Rust crate for serializing and deserializing open api documents

open api open api documents

open api

Rust crate for serializing and deserializing open api documents

Documentation

install

add the following to your Cargo.toml file

usage

Doug Tangren (softprops) 2017

Issues

Collection of the latest Issues

rbtcollins

is help needed?

There seem to be lots of unmerged PRs, and unreleased code changes. Is help needed?

rubenfiszel

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.

pwoolcoc

Unable to deser the "Basic Structure" example from the OpenAPI v2 spec

this crate is unable to deserialize the document shown here, in the OpenAPI v2 spec: https://swagger.io/docs/specification/2-0/basic-structure/ . It fails with the following error:

Here is the code I used to generate the error:

JRAndreassen

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

gabcbrown

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?

softprops

Revisit with formal json schema in mind

https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json

wildarch

Support Security Requirements

Add field "security" to the Spec struct to support Security Requirements

JordiPolo

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

bluejekyll

FYI: Support for Rocket

This isn't an issue per se, but I thought I'd share some mild progress on getting Swagger/OpenAPI output from Rocket: https://users.rust-lang.org/t/anyone-working-on-swagger-openapi-support-in-rocket/11231

This is just an initial POC, but I'm thinking of starting a rocket-openapi repo to continue this. Thanks for this crate!

JordiPolo

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.

JordiPolo

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:

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

JordiPolo

Fail if the spec is not a supported version

Currently there is support for OpenAPI 2.0. I think OpenAPI < 2.0 and > 2.0 are not compatible with 2.0 so probably the deserialization should check the version and fail gracefully

softprops