Struct GraphiQLConfig 

pub struct GraphiQLConfig {
    pub endpoint_url: String,
    pub subscription_url: Option<String>,
    pub theme: GraphiQLTheme,
    pub enable_explorer: bool,
    pub enable_history: bool,
    pub headers: HashMap<String, String>,
    pub cdn_url: String,
    pub custom_css: Option<String>,
}

GraphiQL playground configuration

Provides comprehensive configuration for the GraphiQL playground including themes, subscriptions, headers, and interactive features.

Fields

endpoint_url: String

GraphQL endpoint URL (required)

subscription_url: Option<String>

WebSocket URL for subscriptions (optional)

theme: GraphiQLTheme

UI theme (Light or Dark)

enable_explorer: bool

Enable schema explorer sidebar

enable_history: bool

Enable query history persistence

headers: HashMap<String, String>

Custom HTTP headers

cdn_url: String

CDN URL for GraphiQL (for version pinning)

custom_css: Option<String>

Custom CSS styling

Implementations

impl GraphiQLConfig

pub fn new() -> Self

Create a new GraphiQL configuration with defaults

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

Set the GraphQL endpoint URL

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

Set the WebSocket URL for subscriptions

pub fn theme(self, theme: GraphiQLTheme) -> Self

Set the UI theme

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

Enable or disable the schema explorer

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

Enable or disable query history

pub fn add_header( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a custom HTTP header

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

Set the CDN URL for version pinning

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

Set custom CSS styling

pub fn to_json(&self) -> Value

Convert configuration to JSON for embedding in HTML

Trait Implementations

impl Clone for GraphiQLConfig

fn clone(&self) -> GraphiQLConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphiQLConfig

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

Formats the value using the given formatter.

impl Default for GraphiQLConfig

fn default() -> Self

Returns the “default value” for a type.