Gatsby × microCMS:gatsby-source-microcmsとFile System Route APIで記事ページを作る

「Gatsby Base」は Gatsby 5.16・React 19・microCMS で作ったポートフォリオです。Gatsby では microCMS のデータを GraphQL のデータ層に取り込み、ページから GraphQL で取り出します。記事ページは File System Route API で、テンプレートファイル 1 つから自動生成しています。
リポジトリ:Gatsby-TypeScript-Threejs-MicroCMS-Site / デモ:https://gatsbybase.vercel.app/
gatsby-source-microcms の設定
// gatsby-config.ts
import type { GatsbyConfig } from "gatsby";
// ローカルでは .env.development / .env.production を読む。
// Vercel ではプロジェクト設定の環境変数が使われるので、ファイルが無くても動く。
try {
process.loadEnvFile(`.env.${process.env.NODE_ENV}`);
} catch {}
const config: GatsbyConfig = {
jsxRuntime: "automatic",
graphqlTypegen: true,
plugins: [
{
resolve: "gatsby-source-microcms",
options: {
apiKey: process.env.MICROCMS_API_KEY,
serviceId: process.env.MICROCMS_SERVICE_DOMAIN,
apis: [{ endpoint: "blogs", type: "blog", query: { limit: 100, depth: 1 } }],
},
},
],
};
export default config;type: "blog" にすると、GraphQL では MicrocmsBlog 型と allMicrocmsBlog クエリが使えるようになります。depth: 1 はコンテンツ参照(カテゴリ)を展開するための指定です。
環境変数の読み込みには、以前は dotenv を使っていました。今は Node.js 組み込みの process.loadEnvFile に置き換え、依存パッケージを 1 つ減らしています。ファイルが無いと例外になるので、try で囲んでいます。jsxRuntime: "automatic" を指定すると、各ファイルで import React を書かなくて済みます。
GraphQL Typegen でクエリに型を付ける
graphqlTypegen: true にすると、gatsby develop の実行時にクエリの結果の型が Queries.* として生成されます。以前は gatsby-plugin-typegen で型を作っていましたが、Gatsby 組み込みの機能に置き換えました。生成されるのは src/gatsby-types.d.ts なので、npm run typecheck の前に一度は develop を実行しておきます。
File System Route API
src/pages/articles/{MicrocmsBlog.blogId}.tsx というファイル名にすると、MicrocmsBlog のノードごとに /articles/記事ID のページが作られます。gatsby-node に createPages を書く必要はありません。
なお、microCMS のコンテンツ ID は id ではなく blogId(type 名 + Id)というフィールドに入ります。id は Gatsby 内部のノード ID で、ページのクエリには $id として渡されます。
// src/pages/articles/{MicrocmsBlog.blogId}.tsx
import { graphql, type HeadProps, type PageProps } from "gatsby";
export default function ArticlePage({ data }: PageProps<Queries.ArticlePageQuery>) {
const post = data.microcmsBlog;
return (
<article className="article">
<h1>{post?.title}</h1>
<PostCover eyecatch={post?.eyecatch} seed={0} width={1520} eager />
<div className="prose" dangerouslySetInnerHTML={{ __html: post?.content ?? "" }} />
</article>
);
}
export const query = graphql`
query ArticlePage($id: String!) {
microcmsBlog(id: { eq: $id }) {
title
content
publishedAt
category { name }
eyecatch { url width height }
}
}
`;一覧は GraphQL で並べ替えて 3 件だけ取る
以前は全記事を取得してから JavaScript で日付順に並べ替え、先頭の 3 件を切り出していました。今は並べ替えと件数の指定を GraphQL のクエリに書いています。edges { node } の代わりに nodes を使うと、取り出す側のコードも短くなります。
一覧からのリンクには gatsbyPath を使います。File System Route API が作るのと同じ URL を取得できるので、URL の組み立てを自分で書かずに済み、ルートの形を変えてもリンク切れになりません。
query IndexPage {
allMicrocmsBlog(sort: { publishedAt: DESC }, limit: 3) {
nodes {
id
gatsbyPath(filePath: "/articles/{MicrocmsBlog.blogId}")
title
publishedAt
category { name }
eyecatch { url width height }
}
}
}<head> は Head API で
タイトルや OGP は、ページから Head を export して書きます。共通の Seo コンポーネントを用意し、記事ページだけ og:type を article にしています。
export const Head = ({ data }: HeadProps<Queries.ArticlePageQuery>) => (
<Seo
title={data.microcmsBlog?.title ?? undefined}
image={data.microcmsBlog?.eyecatch?.url ?? undefined}
article
/>
);アイキャッチは microCMS の画像 API で WebP に
microCMS の画像は imgix で配信されているので、URL パラメータでリサイズと形式の変換ができます。URL オブジェクトでパラメータを付けて、srcSet で 2 つのサイズを渡しています。アイキャッチが無い記事には、記事ごとに角度の違う惑星のイラストを SVG で描きます。
// src/components/PostCover.tsx
const imgix = (url: string, w: number) => {
const u = new URL(url);
u.searchParams.set("w", String(w));
u.searchParams.set("fm", "webp");
return u.toString();
};
<img
src={imgix(eyecatch.url, width)}
srcSet={`${imgix(eyecatch.url, width / 2)} ${width / 2}w, ${imgix(eyecatch.url, width)} ${width}w`}
sizes={`(width <= 900px) 100vw, ${width / 2}px`}
width={eyecatch.width ?? undefined}
height={eyecatch.height ?? undefined}
alt=""
/>記事を公開したら自動で再ビルド
ページはビルド時に生成されるので、microCMS で記事を公開しただけではサイトに反映されません。Vercel のプロジェクト設定で Deploy Hook を作り、その URL を microCMS の blogs API の Webhook に登録しておくと、公開・更新・削除のたびに自動でデプロイされます。
まとめ
type名が GraphQL の型名(Microcms○○)になり、コンテンツ ID はblogIdに入る{MicrocmsBlog.blogId}.tsxで記事ページを自動生成し、リンクはgatsbyPathで取得する- 並べ替えと件数は GraphQL のクエリに書く
- 型は組み込みの GraphQL Typegen、環境変数は
process.loadEnvFileで - 公開と同時に反映させるなら、Webhook から Deploy Hook を呼ぶ
Have a project in mind or a question about this post?