# Fumadocs (Framework Mode, TanStack Start): GraphQL
URL: /ja/docs/tanstack-start/integrations/graphql
Source: https://raw.githubusercontent.com/fuma-nama/fumadocs/refs/heads/main/apps/docs/content/docs/(framework)/[framework]/integrations/graphql/index.ja.mdx

GraphQL スキーマからドキュメントを生成します。

## セットアップ [#setup]

必要なパッケージをインストールします。

```npm
npm i @fumadocs/graphql graphql
```

### スタイルの生成 [#generate-styles]

次の行を追加します。

```css title="Tailwind CSS"
@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
/* [!code ++] */
@import '@fumadocs/graphql/css/preset.css';
```

### プラグインの設定 [#configure-plugin]

GraphQL サーバーインスタンスと `<GraphQLPage />` コンポーネントを作成します。

```ts tab="lib/graphql.ts"
import { createGraphQL } from '@fumadocs/graphql/server';

// 注: これはサーバーサイドAPIです
export const graphql = createGraphQL({
  // GraphQLスキーマ。次の形式を指定できます:
  // SDLファイル/URL(`extend type` を含む)、SDLテキスト、
  // イントロスペクション結果、`GraphQLSchema` インスタンス。
  input: ['./schema.graphql'],
});
```

```tsx tab="components/api-page.tsx"
'use client';
import { createGraphQLPage } from '@fumadocs/graphql/ui';

export const GraphQLPage = createGraphQLPage({
  playground: {
    // オペレーションページでインタラクティブなプレイグラウンドを有効にします(省略可)
    url: 'https://api.example.com/graphql',
  },
});
```

各オプションについては、[`createGraphQL()`](/docs/tanstack-start/integrations/graphql/server) と [`createGraphQLPage()`](/docs/tanstack-start/integrations/graphql/api-page) を参照してください。

### ページを生成する [#generate-pages]

[`loader()`](/docs/headless/source-api/source) に `staticSource()` を渡します。ファイルを書き出さずにページを生成できます。

`staticSource()` はファイルを読み込むため、`source.ts` はサーバー専用になります。クライアントのコードから import できるよう、`docs` を `collections.ts` に移動してください。

```ts tab="src/lib/source.ts"
import { loader } from 'fumadocs-core/source';
import { defineDocs } from 'fumadocs-mdx/macro'; // [!code --]
// [!code ++:2]
import { docs } from '@/lib/collections';
import { graphql } from '@/lib/graphql';

// [!code --:6]
export const docs = defineDocs({
  dir: 'content/docs',
  docs: {
    async: true,
  },
});

// `staticSource()` がファイルを読み込むため、サーバー専用になりました [!code ++]
export const source = loader(
  // [!code ++:6]
  {
    docs: docs.toFumadocsSource(),
    graphql: await graphql.staticSource({
      baseDir: 'graphql',
    }),
  },
  {
    baseUrl: '/docs',
    // [!code ++:2] 任意: ページツリーの各ページ項目に query/mutation/subscription のバッジを追加します
    plugins: [graphql.loaderPlugin()],
  },
);
```

```ts tab="src/lib/collections.ts"
import { defineDocs } from 'fumadocs-mdx/macro';

export const docs = defineDocs({
  dir: 'content/docs',
  docs: {
    async: true,
  },
});
```

`staticSource()` はオペレーションごとに1ページを生成し、種類別のフォルダー (例: `queries/`) にまとめます。名前付き型のページは[オプトイン](/docs/tanstack-start/integrations/graphql/server#includeoperations--includetypes)で生成されます。

**`source` のページは `docs` と `graphql` の2種類になりました。** `source` を使用しているすべての箇所を更新してください。

docs ページで `<GraphQLPage />` を使用して GraphQL ページをレンダリングします。

```tsx title="src/routes/docs/$.tsx"
import { docs, source } from '@/lib/source'; // [!code --]
// [!code ++:4]
import { docs } from '@/lib/collections';
import { source } from '@/lib/source';
import { GraphQLPage } from '@/components/api-page';
import type { OperationExample } from '@fumadocs/graphql';

// [!code ++:7]
// サーバー関数の戻り値に対する型レベルのチェックではオペレーションの例を検証できないため、
// シリアライズ可能な型として登録します(`@tanstack/router-core` を解決できない場合はインストールしてください)
declare module '@tanstack/router-core' {
  interface SerializableExtensions {
    graphqlExample: OperationExample;
  }
}

export const Route = createFileRoute('/docs/$')({
  component: Page,
  loader: async ({ params }) => {
    const slugs = params._splat?.split('/') ?? [];
    const data = await serverLoader({ data: slugs });
    if (data.type === 'docs') await docs.getPage(data.path)?.preload(); // [!code highlight]
    return data;
  },
});

const serverLoader = createServerFn({
  method: 'GET',
})
  .validator((slugs: string[]) => slugs)
  .handler(async ({ data: slugs }) => {
    const page = source.getPage(slugs);
    if (!page) throw notFound();

    // [!code ++:9]
    const pageTree = await source.serializePageTree(source.getPageTree());
    if (page.type === 'graphql') {
      return {
        type: 'graphql',
        title: page.data.title,
        props: page.data.getGraphQLPageProps(),
        pageTree,
      };
    }

    return { type: 'docs', path: page.path, pageTree }; // [!code highlight]
  });

function Page() {
  const data = useFumadocsLoader(Route.useLoaderData());

  return (
    <DocsLayout {...baseOptions()} tree={data.pageTree}>
      {/* [!code ++:8] */}
      {data.type === 'graphql' && (
        <DocsPage full>
          <DocsTitle>{data.title}</DocsTitle>
          <DocsBody>
            <GraphQLPage {...data.props} />
          </DocsBody>
        </DocsPage>
      )}
      <Suspense>
        {/* [!code highlight] */}
        {data.type === 'docs' && <Content path={data.path} />}
      </Suspense>
    </DocsLayout>
  );
}
```

<Callout type="warn" title="移行が完了していることを確認してください">
次に進む前に、型チェックを実行してください。

```npm
npm run types:check
```
</Callout>

## 機能 [#features]

公式の GraphQL インテグレーションは、以下の機能をサポートしています。

* オペレーション(query/mutation/subscription)ごとのページ。使用している型をその場で展開して確認できます
* 引数、フィールド、非推奨情報、デフォルト値、`@oneOf` 入力オブジェクト
* スキーマで適用されているディレクティブとその定義
* リクエストとレスポンスの例(自動生成、または[独自のオペレーション](/docs/tanstack-start/integrations/graphql/server#examples)を使用)
* cURL、JavaScript、Go、Python、Java、C#、Rust のコードサンプル
* 変数フォームを備えたプレイグラウンド。WebSocket や SSE 経由で[サブスクリプション](/docs/tanstack-start/integrations/graphql/api-page#subscriptions)も実行できます
* LLM 向けの[ページの Markdown](/docs/tanstack-start/integrations/graphql/server#markdown-for-llms)
* 名前付き型のページ(任意)。スキーマ全体での使用箇所も表示されます

### デモ [#demo]

[GraphQL のサンプル](/docs/graphql)をご覧ください。