# Fumadocs (Framework Mode, Astro): GraphQL
URL: /ja/docs/astro/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/astro/integrations/graphql/server) と [`createGraphQLPage()`](/docs/astro/integrations/graphql/api-page) を参照してください。

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

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

```ts title="src/lib/source.ts"
import { getCollection } from 'astro:content';
import { loader } from 'fumadocs-core/source';
import { toFumadocsSource } from '@fumadocs/astro/source';
import { graphql } from '@/lib/graphql'; // [!code ++]

export const source = loader(
  // [!code ++:6]
  {
    docs: toFumadocsSource(await getCollection('docs'), await getCollection('meta')),
    graphql: await graphql.staticSource({
      baseDir: 'graphql',
    }),
  },
  {
    baseUrl: '/docs',
    // [!code ++:2] 任意: ページツリーの各ページ項目に query/mutation/subscription のバッジを追加します
    plugins: [graphql.loaderPlugin()],
  },
);
```

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

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

GraphQL ページは専用のアイランドでレンダリングします。このアイランドでは、`<GraphQLPage />` を docs レイアウトでラップします。

```astro tab="src/pages/docs/[...slug].astro"
---
import type { GetStaticPaths, InferGetStaticPropsType } from 'astro';
import Layout from '@/layouts/Layout.astro';
import { Docs } from '@/components/docs';
import { GraphQLDocs } from '@/components/graphql-docs'; // [!code ++]
import { source } from '@/lib/source';

export const prerender = true;

export const getStaticPaths = (() => {
  return source.getPages().map((page) => ({
    params: { slug: decodeURI(page.slugs.join('/')) || undefined },
    props: { page },
  }));
}) satisfies GetStaticPaths;

type Props = InferGetStaticPropsType<typeof getStaticPaths>;

const { page } = Astro.props;
const pageTree = await source.serializePageTree(source.getPageTree());
---

{/* [!code ++:13] */}
{page.type === 'graphql' && (
  <Layout title={page.data.title ?? 'My App'}>
    <GraphQLDocs
      client:load
      pathname={Astro.url.pathname}
      params={Astro.params}
      tree={pageTree}
      title={page.data.title}
      props={page.data.getGraphQLPageProps()}
    />
  </Layout>
)}
```

```tsx tab="src/components/graphql-docs.tsx"
import { type SerializedPageTree, useFumadocsLoader } from 'fumadocs-core/source/client';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { DocsBody, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { GraphQLPage } from '@/components/api-page';
import { Provider, type ProviderProps } from '@/components/provider';
import { baseOptions } from '@/lib/layout.shared';
import type { GraphQLPageProps } from '@fumadocs/graphql/ui';

export function GraphQLDocs({
  tree,
  title,
  props,
  ...rest
}: ProviderProps & { tree: SerializedPageTree; title?: string; props: GraphQLPageProps }) {
  const data = useFumadocsLoader({ tree });

  return (
    <Provider {...rest}>
      <DocsLayout {...baseOptions()} tree={data.tree}>
        <DocsPage full>
          <DocsTitle>{title}</DocsTitle>
          <DocsBody>
            <GraphQLPage {...props} />
          </DocsBody>
        </DocsPage>
      </DocsLayout>
    </Provider>
  );
}
```

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

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

## 機能 [#features]

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

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

### デモ [#demo]

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