Enum OpenAPIType 

pub enum OpenAPIType {
    Redoc {
        url: String,
        spec_json_url: Option<String>,
        spec_yaml_url: Option<String>,
    },
    Scalar {
        url: String,
        spec_json_url: Option<String>,
        spec_yaml_url: Option<String>,
    },
    Swagger {
        url: String,
        spec_json_url: String,
        spec_yaml_url: Option<String>,
    },
}

OpenAPI configuration types

Variants

Redoc

Redoc configuration Example:

initializers:
  openapi:
    redoc:
      url: /redoc

Fields

url: String

URL for where to host the redoc OpenAPI spec, example: /redoc

spec_json_url: Option<String>

URL for openapi.json, for example: /openapi.json

spec_yaml_url: Option<String>

URL for openapi.yaml, for example: /openapi.yaml

Scalar

Scalar configuration Example:

initializers:
  openapi:
    scalar:
      url: /scalar

Fields

url: String

URL for where to host the scalar OpenAPI spec, example: /scalar

spec_json_url: Option<String>

URL for openapi.json, for example: /openapi.json

spec_yaml_url: Option<String>

URL for openapi.yaml, for example: /openapi.yaml

Swagger

Swagger configuration Example:

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

Fields

url: String

URL for where to host the swagger OpenAPI spec, example: /swagger-ui

spec_json_url: String

URL for openapi.json, for example: /api-docs/openapi.json

spec_yaml_url: Option<String>

URL for openapi.yaml, for example: /openapi.yaml

Trait Implementations

impl Clone for OpenAPIType

fn clone(&self) -> OpenAPIType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAPIType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAPIType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenAPIType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.