Struct APISpec

pub struct APISpec<'a> { /* private fields */ }

APISpec helps validate conformity to an OpenAPI specification

Implementations

impl<'a> APISpec<'a>

pub fn verify_conformity( spec_files: Vec<String>, method: &str, path: &str, content_type: &str, request_body: &impl Serialize, response: &Response<Bytes>, status_code: &StatusCode, ) -> Result<(), String>

Verify conformity helper of API Specs

pub fn from_file(path: &str) -> APISpec<'a>

APISpec factory from spec

pub fn path(&'a mut self, path: &'a str) -> &'a mut APISpec<'a>

Sets the path to specify/check.

pub fn method(&'a mut self, method: &'a str) -> &'a mut APISpec<'a>

Sets the method to specify/check.

pub fn content_type(&'a mut self, content_type: &'a str) -> &'a mut APISpec<'a>

Sets the content type to specify/check, note that it defaults to “application/json”.

pub fn get_default_spec_file() -> String

Get default spec file

pub fn get_era_spec_file(era: SupportedEra) -> String

Get spec file for era

pub fn get_all_spec_files() -> Vec<String>

Get all spec files

pub fn get_all_spec_files_from(root_path: &str) -> Vec<String>

Get all spec files in the directory

pub fn verify_examples(&self) -> Vec<String>

Verify that examples are conform to the type definition.