こんにちは、Naotoです。
Next.jsでのWebサイト制作 #4 では、microCMSを使ったWebサイトへのBlog記事投稿について紹介したいと思います。
microCMSとは?
microCMSとは、APIベースの日本製ヘッドレスCMSです。
ヘッドレスCMSとは?
ヘッドレスCMSとは、フロントエンド機能を持たず、バックエンド機能のみを備えたCMSのことです。
つまり、microCMSのGUI上でデータを登録し、フロントエンドからAPIを叩くことで、取得したデータを自由に画面上に表示することができます。(フロントエンドは自分で実装する必要があるため、画面に表示する際の自由度が高いです。)
本Webサイトにおける使用例
本Webサイトにおいては、Blogページ、GalleryページにてmicroCMSを使用しました。
以下のように、microCMSの管理画面で投稿した記事を各コンポーネントで取得し、表示するといった処理をしています。
気づいた方もいると思いますが、Galleryページに掲載している画像は、Blogページの各記事のサムネと同じ画像になっております。
そのため、microCMSからのデータ取得方法も一緒となりますので、今回は、Blogページの実装方法のみ説明させていただきたいと思います。
やってみよう!
では早速、microCMSにブログ記事を投稿し、Webブラウザに表示する手順を説明します。
microCMSでのGUI操作
※アカウント作成方法は割愛させていただきます。
サービスの作成
APIの作成
①「自分で決める」をクリック。(「ブログ」や「お知らせ」を選ぶとある程度自動でやってくれる。)
④APIスキーマを定義
ここでデータの構造を定義します。
今回はブログ記事のため、「タイトル」「写真」「本文」を定義します。
フロントエンド側でAPIを叩いた際は、以下のようなJSONが返ってきます。
※「id」~「revisedAt」はデフォルトで設定されています。
{
contents: [
{
id: '9dl-1anaj_ml',
createdAt: '2024-07-21T01:42:13.847Z',
updatedAt: '2024-07-21T03:49:12.060Z',
publishedAt: '2024-07-21T01:42:13.847Z',
revisedAt: '2024-07-21T03:49:12.060Z',
title: 'ここにタイトルのデータが入ってくる',
photo: {
ここに写真のデータが入ってくる。
},
body: 'ここに本文のデータが入ってくる。'
},
{
他のブログ記事
},
{
他のブログ記事
},
],
}
記事の投稿
完了
上記ステップでmicroCMSへのブログ記事投稿は完了です。
とっても簡単です。
フロントエンドからデータを取得する
では次に、microCMSにて公開したデータをフロントエンドで取得し、画面に表示する手順を説明します。
インストール
まず、microCMSを扱うには以下のインストールが必要です。
npm install microcms-js-sdk
client.jsの作成
次に、microCMSとプロジェクトを連携するために、プロジェクトフォルダ直下にlibs/client.jsを作成し、以下を実装します。
import { createClient } from "microcms-js-sdk";
if (!process.env.API_KEY) {
throw new Error("API_KEY is not defined");
}
export const client = createClient({
serviceDomain: "blog-guidance",
apiKey: process.env.API_KEY
});
-
serviceDomain
microCMS GUI上の、「API設定→基本情報→エンドポイント」に書かれている、
https://"ここの部分".microcms.io/api/v1/blog
を入力します。 -
apiKey
microCMS GUI上の、「権限管理→APIキー」に書かれているキーを、
.envファイルに記載し、呼び出す。
全ブログ記事のデータ取得&表示
microCMSとプロジェクトの連携ができたら、いよいよデータを取得します。
microcms-js-sdkを利用することで、microCMS上の全ブログ記事のデータを以下のように取得できます。
↑GUI上の「APIプレビュー」の画面
上記に倣ってデータを取得してみます。
※今回はSSRにてデータを取得しています。const revalidate = 0; を定義するだけで、SSRを使えます。
const revalidate = 60; とすると60秒間のISRとなります。
revalidateを定義しないと、SSGとなります。
↓詳しくは以下公式ドキュメントを参照ください。
それでは早速実装してみます!
以下は、本WebサイトのBlogコンポーネント(page.tsx)です。
ここで全ブログ記事のデータを取得し、子コンポーネントに渡します。
import { client } from "../../../libs/client";
import BlogList from "./BlogList";
// ブログページ
// SSR設定(MicroCMS独自の書き方)
export const revalidate = 0;
export default async function Blog() {
let blog = [];
let error = null;
try {
// microCMSからブログ情報を取得
const data = await client.get({ endpoint: "blog" });
blog = data.contents; //オブジェクトとして取得されるため、contentsフィールドのみ取得
} catch (err) {
console.error("Failed to fetch blog data:", err);
error = "Failed to fetch blog data. Please try again later.";
}
return (
<div className="container mx-auto p-5">
{/* タイトル */}
<h1 className="m-2 md:m-4 font-bold text-gray-100 text-3xl lg:text-5xl italic">
🥍 Blog 🥍
</h1>
{error ? (
<p className="text-red-500">{error}</p>
) : (
// 取得したデータを子コンポーネントに渡す。
<BlogList blog={blog} />
)}
</div>
);
}
上記にて、ブログ記事データをJSON形式で取得し、子コンポーネントに渡すことができました。
次に、子コンポーネントで受け取った全ブログ記事のデータを表示してみましょう。
※以下JSX部分の抜粋。
<div className="grid grid-cols-1 sm:grid-cols-2 md:grid-colos-3 lg:grid-cols-4 xl:grid-cols-5 gap-6 ">
{/* 全ブログ記事のデータを展開 */}
{blog.map((blog: any, index: number) => (
<div key={blog.id}>
<article className="bg-yellow-300 text-black shadow-lg rounded-lg overflow-hidden h-auto border-4 border-black hover:border-yellow-500">
{/* 個々のブログへのリンク */}
<Link href={`blog/${blog.id}`}>
<div className="relative">
<img
src={blog.photo.url}
alt={blog.title}
className="w-full h-64 object-cover"
/>
<div className="p-6 h-40 relative">
<h3 className="text-xl font-semibold">{blog.title}</h3>
<p className="text-xs sm:text-sm md:text-base text-gray-600 absolute bottom-5">
{formatDate(blog.publishedAt)}
</p>
</div>
</div>
</Link>
</article>
</div>
))}
</div>
上記のように、受け取ったデータをmap関数で展開し、「blog.id」「blog.title」のようにして画面に出力しています。
そして、それぞれのarticleにLinkタグをつけ、個々のブログページ"blog/blog.id"に遷移されるようにしています。
すると、以下のように全ブログ記事のデータが画面上に表示されるようになりました!!!
個々のブログ記事のデータ取得&表示
個々のブログ記事のデータ取得方法は、全ブログ記事のデータの取得方法と大きく変わらず、
エンドポイントの後ろに個々のidをつけることでデータを取得できます。
{endpoint}/{content_id}
画面への表示方法も同じですので、説明は割愛します。
ぜひ個々のブログページも作成してみてください。
最後に
最後までお読みいただき、ありがとうございました。
今回はBlogページをもとに、microCMSを使ってWebサイトにBlog記事を投稿する方法について紹介しました。
Webサイトには、Blog記事の他にも、 Newsなど定期的に発信したいコンテンツが盛り込まれることが多いと思います。
ぜひそういった際には、microCMSを使ってみてはいかがでしょうか。
次回は、Contactページにおける、Email JSを使った問合せフォームの作成方法について紹介する予定です。
ぜひ読んでいただければ幸いです。
ありがとうございました!!!