Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

Syntax

Mintlify.Core.Models.MdxConfig

Summary

Represents the MDX configuration for API pages generated from MDX files.

Remarks

This configuration allows manual definition of API endpoints in individual MDX files rather than using an OpenAPI specification. It provides flexibility for custom content and is useful for documenting small APIs or prototyping.

Constructors

.ctor

Syntax

public MdxConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Auth

Gets or sets the authentication configuration for MDX-based API requests.

Syntax

public Mintlify.Core.Models.MdxAuthConfig Auth { get; set; }

Property Value

Type: Mintlify.Core.Models.MdxAuthConfig?

Remarks

Defines the authentication method and parameters required for API calls made from the documentation playground.

Server

Gets or sets the base server URL(s) for API requests.

Syntax

public Mintlify.Core.Models.ServerConfig Server { get; set; }

Property Value

Type: Mintlify.Core.Models.ServerConfig?

Examples

// Single server
"server": "https://api.example.com"

// Multiple servers
"server": ["https://api1.example.com", "https://api2.example.com"]

Remarks

Can be a single string URL or an array of URLs for multiple base endpoints. Used as the base URL for all API requests made from the playground.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?