スタンドアロン

npx @fumadocs/openapi-standalone build ./openapi.yaml

npx @fumadocs/openapi-standalone serve ./openapi.yaml --port 8080

import type { Config } from '@fumadocs/openapi-standalone';

export default {
  input: ['./openapi.yaml'],
  outDir: 'out',
} satisfies Config;

import { generateStatic } from '@fumadocs/openapi-standalone';

await generateStatic({
  input: ['./openapi.yaml'],
  outDir: 'out',
});

out/
├── index.html                   # ドキュメントの概要
├── pets/listPets/index.html     # オペレーションごとに 1 ページ
├── 404.html
└── _fumadocs/                   # スクリプト、スタイル、ドキュメント、検索インデックス

import { Hono } from 'hono';
import { createApp } from '@fumadocs/openapi-standalone/hono';

const app = new Hono();

// ルートは `baseUrl` 配下に配置されます
app.route(
  '/',
  createApp({
    input: ['./openapi.yaml'],
    baseUrl: '/docs',
    // API プレイグラウンド用の CORS プロキシです。`servers` 内の絶対 URL にのみリクエストを転送します
    proxy: true,
  }),
);

export default app;

await generateStatic({
  // ファイルパスと URL の配列、またはドキュメント ID から ファイルパス・URL・ドキュメントオブジェクトへのレコード
  input: ['./openapi.yaml', './billing.yaml'],
  // 書き込み前に中身が削除されます
  outDir: 'out',
  // 'operation'(デフォルト)、'tag'、'file' ごとに 1 ページ
  per: 'operation',
  // オペレーションページのフォルダー: 'tag'(オペレーションにタグがある場合のデフォルト)、'route'、'none'
  groupBy: 'tag',
  // ドキュメントを配信する URL パス(デフォルト: '/')
  baseUrl: '/docs',
  // デフォルト: ドキュメントの `info.title`
  title: 'Acme API',
  // API プレイグラウンド用の `createProxy()` ルート
  proxyUrl: 'https://example.com/api/proxy',
});