Struct oas_gen::Oas3Builder

pub struct Oas3Builder { /* fields omitted */ }

Implementations

impl Oas3Builder

pub fn any<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    method: Method,
    document_name: String,
    operation_name: &str,
    operation_description: Option<String>
)

pub fn any_with_tests<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    method: Method,
    document_name: String,
    operation_name: &str,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn create<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn create_with_tests<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn delete<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn delete_with_tests<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

pub fn delete_by_key<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn delete_by_key_with_tests<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn fetch<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn fetch_with_tests<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

This variant accepts a test spec

use oas_gen::xtests::{Test,Response};
let mut params = std::collections::BTreeMap::default();
params.insert("key".to_owned(), "8472".to_owned());
let test_ok = Test {
    description: "Fetch a document by key.".to_owned(),
    response: Response {
        status: vec![200],
        ..Response::default()
    },
    params,
    ..Test::default()
};
assert_eq!(r#"{"description":"Fetch a document by key.","params":{"key":"8472"},"response":{"status":[200]}}"#, serde_json::to_string(&test_ok).unwrap());
let tests = vec![test_ok];

impl Oas3Builder

pub fn list<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn list_with_tests<O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn replace<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn replace_with_tests<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn update<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>
)

pub fn update_with_tests<I: JsonSchema + Serialize, O: JsonSchema + Serialize, E: JsonSchema + Serialize>(
    &mut self,
    web_path: &ApiPath,
    document_name: String,
    operation_description: Option<String>,
    tests: &[Test]
)

impl Oas3Builder

pub fn new() -> Self

pub fn build(self, version: String) -> OpenApi

pub fn create_bearer_scheme() -> SecurityScheme

Create a http bearer Auth security scheme

pub fn build_with_security(
    self,
    version: String,
    security_schemes: Map<String, RefOr<SecurityScheme>>
) -> OpenApi

let mut security_schemes: Map<String, RefOr<SecurityScheme>> = Map::default();
let security_scheme = create_bearer_scheme();
security_schemes.insert("bearerAuth".to_owned(), RefOr::Object(security_scheme));

Trait Implementations

impl Clone for Oas3Builder

fn clone(&self) -> Oas3Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Oas3Builder

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

Formats the value using the given formatter.

impl Default for Oas3Builder

fn default() -> Self

Returns the “default value” for a type.