Fumadocs

Fumadocs is a modern documentation framework built on Next.js for building developer documentation sites. It provides a complete set of composable packages for content loading, navigation tree generation, full-text search, UI components, and interactive API reference generation from OpenAPI specifications.

3 APIs 0 Features

DocumentationFrameworkNext.jsReact

APIs

Fumadocs

Fumadocs is an open-source documentation framework built on Next.js and React for creating fast, modern developer documentation sites. It provides a full stack of composable pac...

Fumadocs Search API

The Fumadocs Search API is a server-side HTTP endpoint embedded in each Fumadocs documentation site that enables full-text search across all indexed documentation content. The e...

Fumadocs OpenAPI Proxy API

The Fumadocs OpenAPI Proxy API is a server-side HTTP proxy included in the fumadocs-openapi package that enables the interactive API playground to make authenticated requests to...

Collections

Fumadocs OpenAPI Proxy API

OPEN

Fumadocs Search API

OPEN

Pricing Plans

Fumadocs Plans Pricing

1 plans

PLANS

Rate Limits

Fumadocs Rate Limits

1 limits

RATE LIMITS

FinOps

Fumadocs Finops

FINOPS

Semantic Vocabularies

Fumadocs Context

0 classes · 7 properties

JSON-LD

Resources

Documentation

Documentation

Documentation

Documentation

Distribution

Distribution

Distribution

Sources

opencollection: 1.0.0
info:
  name: Fumadocs Search API
  version: 16.6.17
items:
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Fumadocs Search documentation content
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/search'
      params:
      - name: query
        value: ''
        type: query
        description: The search query string. When absent or empty, an empty results array is returned immediately without
          querying the index.
      - name: locale
        value: ''
        type: query
        description: BCP 47 locale code to filter results to a specific language version of the documentation site. Useful
          for internationalized sites.
      - name: tag
        value: ''
        type: query
        description: One or more comma-separated tag values to restrict search results to specific sections or categories
          within the documentation. Multiple tags are separated by commas.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return. When omitted, the search engine's default limit is used.
    docs: Searches indexed documentation content and returns a ranked list of matching pages, headings, and text segments.
      Accepts a query string and optional filters for locale and tag. Returns an empty array when no query is provided. Each
      result includes the page URL, content type, breadcrumbs, and highlighted content. The default endpoint path is /api/search
      but can be customized per site.
  - info:
      name: Fumadocs Export the search index for static/client-side search
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/search/static'
    docs: Exports the full search index database so that client-side search implementations can download and query it locally
      without making per-query requests. The response format depends on the underlying search engine (Orama, Flexsearch, etc.)
      configured by the site. This endpoint path is a convention; actual path may vary per documentation site.
bundled: true