createOpenAPI()

OpenAPI Server

The main config for Fumadocs OpenAPI.

input

The OpenAPI schemas to read from.

• File Paths
• External URLs
• A function (see below)

import { createOpenAPI } from 'fumadocs-openapi/server';

export const openapi = createOpenAPI({
  input: ['./unkey.json'],
});

Creating Proxy

A proxy server is useful for executing HTTP (fetch) requests, as it doesn't have CORS constraints like on the browser. We can use it for executing HTTP requests on the OpenAPI playground, when the target API endpoints do not have CORS configured correctly.

Setup

Create a route handler for proxy server.

import { openapi } from '@/lib/openapi';

export const { GET, HEAD, PUT, POST, PATCH, DELETE } = openapi.createProxy({
  // optional, we recommend to set a list of allowed origins for proxied requests
  allowedOrigins: ['https://example.com'],
});

And set the proxy URL in createOpenAPI.

import { createOpenAPI } from 'fumadocs-openapi/server';

export const openapi = createOpenAPI({
  proxyUrl: '/api/proxy',
});