Struct Validator 

pub struct Validator { /* private fields */ }

One OpenAPI description, ready to judge requests against.

Building one walks the description’s paths once; validating is then a match and a handful of schema checks, so a server builds this at startup and keeps it.

use roas_http_validator::{RequestView, Validator};

let spec = serde_json::from_str(r#"{
  "openapi": "3.2.0",
  "info": { "title": "Pets", "version": "1.0.0" },
  "paths": {
    "/pets/{petId}": {
      "get": {
        "operationId": "getPet",
        "parameters": [
          { "name": "petId", "in": "path", "required": true,
            "schema": { "type": "integer" } }
        ]
      }
    }
  }
}"#)?;

let validator = Validator::new(spec);
assert!(validator.validate(&RequestView::new("GET", "/pets/7"))?.is_valid());
assert!(!validator.validate(&RequestView::new("GET", "/pets/rex"))?.is_valid());

Implementations

impl Validator

pub fn new(spec: Spec) -> Self

Prepare a v3.2 description with the default Options.

pub fn with_options(spec: Spec, options: Options) -> Self

Prepare a v3.2 description.

pub fn spec(&self) -> &Spec

The description being validated against.

pub fn validate( &self, request: &RequestView<'_>, ) -> Result<ValidationReport, RoutingError>

Judge one request.

Errors

RoutingError when the request cannot be judged at all, which is a different answer from “the request is invalid” and usually a different response code:

• RoutingError::PathNotFound — no template matches the path.
• RoutingError::MethodNotAllowed — a template matches and describes other methods, but not this one.
• RoutingError::Unresolved — a template matches but its Path Item Object could not be read, so neither of the above can be said honestly.

impl Validator

pub fn from_v3_1(spec: Spec, options: Options) -> Self

Prepare a v3.1 description, upconverting it to v3.2 first.

pub fn from_v3_0(spec: Spec, options: Options) -> Self

Prepare a v3.0 description, upconverting it to v3.2 first.

pub fn from_v2(spec: Spec, options: Options) -> Self

Prepare a v2.0 (Swagger) description, upconverting it to v3.2 first.

Trait Implementations

impl Clone for Validator

fn clone(&self) -> Validator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Validator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.