Struct GraphQLRouteConfig 

pub struct GraphQLRouteConfig { /* private fields */ }

Configuration for GraphQL routes

Provides a builder pattern for configuring GraphQL route parameters for the Spikard HTTP server’s routing system.

Example

use spikard_graphql::routes::GraphQLRouteConfig;

let config = GraphQLRouteConfig::new()
    .path("/graphql")
    .method("POST")
    .enable_playground(true);

assert_eq!(config.get_path(), "/graphql");
assert_eq!(config.get_method(), "POST");

Implementations

impl GraphQLRouteConfig

pub fn new() -> Self

Create a new GraphQL route configuration with defaults

Default values:

• path: “/graphql”
• method: “POST”
• enable_playground: false

pub fn path(self, path: impl Into<String>) -> Self

Set the HTTP path for the GraphQL endpoint

Arguments

• path - The URL path (e.g., “/graphql”, “/api/graphql”)

pub fn method(self, method: impl Into<String>) -> Self

Set the HTTP method for the GraphQL endpoint

Arguments

• method - The HTTP method (typically “POST”)

pub const fn enable_playground(self, enable: bool) -> Self

Enable or disable the GraphQL Playground UI

Arguments

• enable - Whether to enable playground

pub fn description(self, description: impl Into<String>) -> Self

Set a custom description for documentation

Arguments

• description - Documentation string

pub fn get_path(&self) -> &str

Get the configured path

pub fn get_method(&self) -> &str

Get the configured method

pub const fn is_playground_enabled(&self) -> bool

Check if playground is enabled

pub fn get_description(&self) -> Option<&str>

Get the description if set

Trait Implementations

impl Clone for GraphQLRouteConfig

fn clone(&self) -> GraphQLRouteConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQLRouteConfig

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

Formats the value using the given formatter.

impl Default for GraphQLRouteConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphQLRouteConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphQLRouteConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.