本文へ移動
← Archive No.04 / 15 Astro →
Astro

Astro × microCMSでブログ記事を静的生成する(Content Layer + astro:env)

Astro

「Astro Base」は、microCMS の記事をビルド時に取得して静的な HTML として書き出すポートフォリオサイトです。以前は各ページで microCMS の API を直接呼んでいましたが、今は記事を Astro の Content Layer(コンテンツコレクション)として読み込み、API キーは astro:env で扱っています。この記事では、その構成を順に紹介します。

リポジトリ:Astro-MicroCMS-Site / デモ:https://astrobase.vercel.app/

microCMS 側の設定

リスト形式の API を作り、エンドポイントを blogs にします。

フィールド ID

種類

title

テキストフィールド

content

リッチエディタ

eyecatch

画像

category

コンテンツ参照(name を持つ)

1. 環境変数を astro:env で宣言する

API キーなどの環境変数は、astro.config.mjs でスキーマとして宣言します。context: 'server' と access: 'secret' を付けた変数はサーバー側のコードからしか読めないので、API キーがブラウザ向けのコードに混ざることはありません。

js
// astro.config.mjs
import { defineConfig, envField } from 'astro/config';

export default defineConfig({
  env: {
    schema: {
      MICROCMS_SERVICE_DOMAIN: envField.string({ context: 'server', access: 'secret' }),
      MICROCMS_API_KEY: envField.string({ context: 'server', access: 'secret' }),
    },
    validateSecrets: true,
  },
});

validateSecrets: true にしておくと、変数を設定し忘れたときにビルドがエラーで止まります。Vercel に環境変数を入れ忘れたまま、空のサイトが公開されることを防げます。

2. 取得処理を 1 か所にまとめる

宣言した変数は astro:env/server から読み込みます。import.meta.env と違い、型が付いた値として扱えます。

ts
// src/lib/microcms.ts
import { createClient } from 'microcms-js-sdk'
import { MICROCMS_API_KEY, MICROCMS_SERVICE_DOMAIN } from 'astro:env/server'
import type { ArticleResponse } from '../types/article'

export const microcmsClient = createClient({
  serviceDomain: MICROCMS_SERVICE_DOMAIN,
  apiKey: MICROCMS_API_KEY,
})

export const getArticles = async () => {
  const { contents } = await microcmsClient.get<ArticleResponse>({
    endpoint: 'blogs',
    queries: {
      fields: ['id', 'title', 'content', 'eyecatch', 'category', 'publishedAt'],
      limit: 100,
    },
  })
  return contents
}

ArticleResponse は、microCMS が返す JSON の形を書いた型です(src/types/article.ts)。

3. 記事をコンテンツコレクションにする

ここが以前との一番大きな違いです。src/content.config.ts で、microCMS の記事をコレクションとして登録します。

ts
// src/content.config.ts
import { defineCollection } from 'astro:content'
import { z } from 'astro/zod'
import { getArticles } from './lib/microcms'

const blogs = defineCollection({
  loader: async () => (await getArticles()).map((article, order) => ({ ...article, order })),
  schema: z.object({
    order: z.number(),
    title: z.string(),
    content: z.string(),
    publishedAt: z.string(),
    eyecatch: z.object({ url: z.url(), width: z.number().optional(), height: z.number().optional() }).optional(),
    category: z.object({ name: z.string() }).nullish(),
  }),
})

export const collections = { blogs }

loader に渡した関数は、ビルドの最初に 1 回だけ実行されます。各記事の id がそのままエントリーの ID になり、残りのフィールドは schema でチェックされます。

Content Layer にしてよかった点は 2 つあります。

  • API へのリクエストが 1 回で済む:以前はトップページ・記事一覧・記事ページがそれぞれ getArticles() を呼んでいました。今はどのページも、ビルド時に取得済みのデータを getCollection() で読むだけです。
  • データの形をビルド時に確かめられる:microCMS 側でフィールドを消したり型を変えたりすると、スキーマと合わずにビルドが止まります。壊れたページが公開される前に気づけます。

order は、microCMS が返した順番(新しい順)を残すために足しています。getCollection() は並び順を保証しないので、この番号で並べ直します。

ts
// src/lib/posts.ts
import { getCollection, type CollectionEntry } from 'astro:content'

export type Post = CollectionEntry<'blogs'>

export const getPosts = async (): Promise<Post[]> =>
  (await getCollection('blogs')).sort((a, b) => a.data.order - b.data.order)

4. 記事ページを getStaticPaths で生成する

getStaticPaths で記事の数だけパスを返し、記事データは props で渡します。コレクションのエントリーは、ID が post.id、中身が post.data に入っています。

astro
---
// src/pages/articles/[slug].astro
import { getPosts, type Post } from '../../lib/posts'

export const getStaticPaths = async () => {
  const posts = await getPosts()
  return posts.map((post, i) => ({
    params: { slug: post.id },
    props: { post, newer: posts[i - 1] ?? null, older: posts[i + 1] ?? null },
  }))
}

const { post } = Astro.props as { post: Post }
const { data: article } = post
---
<h1>{article.title}</h1>
<article set:html={article.content} />

新しい順に並んでいるので、1 つ前の記事が「次の記事」、1 つ後ろが「前の記事」になります。前後の記事へのリンクも、追加のリクエストなしで作れます。

リッチエディタの HTML は set:html で埋め込みます。{article.content} と書くとエスケープされて、タグが文字として表示されるので注意してください。

トップには最新 3 件だけ

トップページでも同じ getPosts() を使い、先頭の 3 件だけを表示します。

ts
const posts = (await getPosts()).slice(0, 3);

記事を更新したら再デプロイ

静的出力なので、microCMS で記事を公開しただけではサイトに反映されません。microCMS の Webhook に Vercel の Deploy Hook を登録しておくと、公開と同時に再ビルドされます。

まとめ

  • 環境変数は astro:env で宣言し、API キーはサーバー専用にする
  • 取得処理は src/lib/microcms.ts に集約
  • 記事は Content Layer のコレクションにして、リクエストをビルドごとに 1 回にする
  • スキーマで、microCMS のデータの形をビルド時に確かめる
  • 本文は set:html で出力
  • 反映は Webhook + Deploy Hook で自動化