Skip to main content

Definition

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

Syntax

Summary

Represents the API reference configuration and playground settings for Mintlify.

Remarks

This configuration controls how API documentation is displayed and how the API playground functions, including OpenAPI, AsyncAPI, and MDX-based API specifications.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

AsyncApi

Gets or sets the AsyncAPI specification configuration.

Syntax

Property Value

Type: Mintlify.Core.Models.ApiSpecConfig?

Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files.

Examples

Gets or sets the configuration for autogenerated API examples.

Syntax

Property Value

Type: Mintlify.Core.Models.ApiExamplesConfig?

Remarks

Controls which programming languages are shown in code examples and whether optional parameters are included in the generated examples.

Mdx

Gets or sets the MDX configuration for API pages generated from MDX files.

Syntax

Property Value

Type: Mintlify.Core.Models.MdxConfig?

Remarks

Allows manual definition of API endpoints in individual MDX files rather than using an OpenAPI specification. Useful for small APIs or prototyping.

OpenApi

Gets or sets the OpenAPI specification configuration.

Syntax

Property Value

Type: Mintlify.Core.Models.ApiSpecConfig?

Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files.

Params

Gets or sets the display settings for API parameters.

Syntax

Property Value

Type: Mintlify.Core.Models.ApiParamsConfig?

Remarks

Controls how API parameters are displayed in the documentation, including whether they are expanded by default.

Playground

Gets or sets the API playground settings.

Syntax

Property Value

Type: Mintlify.Core.Models.ApiPlaygroundConfig?

Remarks

Controls the display mode of the API playground and whether requests are proxied through Mintlify’s servers for CORS handling.

Proxy

Gets or sets whether to pass API requests through a proxy server.

Syntax

Property Value

Type: System.Nullable<bool>?

Remarks

When true, API requests from the playground are routed through Mintlify’s proxy servers to handle CORS restrictions. This is a legacy property that is superseded by Playground.Proxy but kept for backward compatibility. Defaults to true when not specified.

Url

Gets or sets the base URL display mode for API endpoints.

Syntax

Property Value

Type: string?

Remarks

Controls how the base URL is displayed in API documentation.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?