Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zudoku Configuration API

Zudoku is an open-source, developer-first API documentation framework built by Zuplo. It uses a file-based configuration model (zudoku.config.ts) to generate interactive API documentation from OpenAPI v2/v3 schemas. The configuration API defines how API references, navigation, authentication (OAuth2, OpenID Connect), theming, plugins, and MDX documentation pages are structured and managed.

Zudoku Configuration API is one of 6 APIs that Zudoku publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Configuration, Developer Tools, and Documentation. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, a JSON-LD context, and 5 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://zudoku.dev.

1 operations 1 paths 11 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Server
https://zudoku.dev
Contact
License
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Configuration 1

Top-level Zudoku configuration management.

GET
/config
Retrieve Zudoku Configuration
getConfiguration → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ZudokuConfig (11 properties), SidebarItem (5 properties), ApiReference (5 properties), AuthenticationConfig (5 properties). Each schema is shown below with its type and property counts.

DocConfig
object
Configuration for MDX-based documentation pages.
1 property
ApiReference
object
Configuration for an API reference that points to an OpenAPI schema document. Supports file-based and URL-based references, versioning, and server URL override…
5 properties 2 required
Redirect
object
A URL redirect rule.
2 properties
ThemeConfig
object
Theme and branding configuration for customizing the look and feel of the generated documentation portal.
3 properties
AuthenticationConfig
object
Authentication configuration supporting OpenID Connect, OAuth2, and custom authentication providers for the documentation portal and API playground.
5 properties
ThemeColors
object
Color palette for a theme mode.
3 properties
SidebarItem
object
A sidebar navigation item which can be a page, link, or category.
5 properties
ZudokuConfig
object
The top-level Zudoku configuration object, typically defined in zudoku.config.ts or zudoku.config.tsx.
11 properties
Plugin
object
A Zudoku plugin configuration. Plugins extend the platform with additional functionality such as search, analytics, and custom pages.
2 properties
Metadata
object
Site metadata for SEO and social sharing.
3 properties
NavigationItem
object
A top navigation bar item.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zudoku-configuration-api-openapi.yml Raw ↑

Other APIs Zudoku publishes across the network.

Zudoku API References API
Zudoku Authentication API
Zudoku Navigation API
Zudoku Plugins API
Zudoku Theming API