https://github.com/x52dev/oas3-rs

Structures and tools to parse, navigate and validate OpenAPI v3.1 specifications.
https://github.com/x52dev/oas3-rs

openapi openapi31 rust

Last synced: 2 days ago
JSON representation

Structures and tools to parse, navigate and validate OpenAPI v3.1 specifications.

• Host: GitHub
• URL: https://github.com/x52dev/oas3-rs
• Owner: x52dev
• License: mit
• Created: 2020-10-12T16:49:47.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T03:06:45.000Z (5 days ago)
• Last Synced: 2024-12-23T20:39:13.986Z (4 days ago)
• Topics: openapi, openapi31, rust
• Language: Rust
• Homepage:
• Size: 603 KB
• Stars: 43
• Watchers: 3
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `oas3`

[![crates.io](https://img.shields.io/crates/v/oas3?label=latest)](https://crates.io/crates/oas3)

[![Documentation](https://docs.rs/oas3/badge.svg?version=0.12.1)](https://docs.rs/oas3/0.12.1)

[![dependency status](https://deps.rs/crate/oas3/0.12.1/status.svg)](https://deps.rs/crate/oas3/0.12.1)

![MIT or Apache 2.0 licensed](https://img.shields.io/crates/l/oas3.svg)




[![CI](https://github.com/x52dev/oas3-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/x52dev/oas3-rs/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/x52dev/oas3-rs/branch/main/graph/badge.svg)](https://codecov.io/gh/x52dev/oas3-rs)

![Version](https://img.shields.io/crates/msrv/oas3.svg)

[![Download](https://img.shields.io/crates/d/oas3.svg)](https://crates.io/crates/oas3)

Structures and tools to parse, navigate and validate [OpenAPI v3.1] specifications.

Note that due to v3.1 being a breaking change from v3.0, you may have trouble correctly parsing

specs in the older format.

## Example

```rust

match oas3::from_path("path/to/openapi.yml") {

  Ok(spec) => println!("spec: {:?}", spec),

  Err(err) => println!("error: {}", err)

}

```

[OpenAPI v3.1]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md