createOpenAPI()

OpenAPI 服务器

🌐 OpenAPI Server

Fumadocs OpenAPI 的主要配置。

🌐 The main config for Fumadocs OpenAPI.

input

要读取的 OpenAPI 模式。

🌐 The OpenAPI schemas to read from.

• 文件路径
• 外部网址
• 一个函数（见下文）

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

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

创建代理

🌐 Creating Proxy

代理服务器对于执行 HTTP（fetch）请求非常有用，因为它不像浏览器那样受 CORS 限制。当目标 API 端点没有正确配置 CORS 时，我们可以在 OpenAPI Playground 上使用它来执行 HTTP 请求。

🌐 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'],
});

并在 createOpenAPI 中设置代理 URL。

🌐 And set the proxy URL in createOpenAPI.

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

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