Struct OpenAPIConfig 

pub struct OpenAPIConfig {
    pub redoc: Option<OpenAPIType>,
    pub scalar: Option<OpenAPIType>,
    pub swagger: Option<OpenAPIType>,
}

OpenAPI configuration Example:

initializers:
  openapi:
    redoc:
      url: /redoc
      # spec_json_url: /redoc/openapi.json
      # spec_yaml_url: /redoc/openapi.yaml
    scalar:
      url: /scalar
      # spec_json_url: /scalar/openapi.json
      # spec_yaml_url: /scalar/openapi.yaml
    swagger:
      url: /swagger
      spec_json_url: /api-docs/openapi.json
      # spec_yaml_url: /api-docs/openapi.yaml

Fields

redoc: Option<OpenAPIType>

Redoc configuration Example:

initializers:
  openapi:
    redoc:
      url: /redoc

scalar: Option<OpenAPIType>

Scalar configuration Example:

initializers:
  openapi:
    scalar:
      url: /scalar

swagger: Option<OpenAPIType>

Swagger configuration Example:

initializers:
  openapi:
    swagger:
      url: /swagger
      spec_json_url: /openapi.json

Trait Implementations

impl Clone for OpenAPIConfig

fn clone(&self) -> OpenAPIConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAPIConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAPIConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenAPIConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.