Creating Proxy

Introduction

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.

Warning

Do not use this on unreliable sites and API endpoints, the proxy server will forward all received headers & body, including HTTP-only Cookies and Authorization header.

Setup

Create a route handler for proxy server.

/api/proxy/route.ts

import { openapi } from '@/lib/source';
 
export const { GET, HEAD, PUT, POST, PATCH, DELETE } = openapi.createProxy();

Follow the Getting Started guide if openapi server is not yet configured.

And enable the proxy from createOpenAPI.

lib/source.ts

import { createOpenAPI } from 'fumadocs-openapi/server';
 
export const openapi = createOpenAPI({
  proxyUrl: '/api/proxy',
});

Introduction

Setup

On this page