microCMSのManagement APIでAPIスキーマを取得し、 型を生成する CLI(@wato787/microcms-cli) を(ほぼAIが)作り、npm に publish しました。
作った理由
microCMS のデータに型をつけたいとき、手で書くのは手間になります。Management API でスキーマが取得できるので、そこから型を自動生成することにしました。
人間もAIも簡単に使えるようCLIにしました。
- generate:types blog で 1 つの API の型を生成
- generate:types --all で全 API を一括生成
出力は microcms.d.ts にまとまります。共通型は microcms-js-sdk に合わせています。
使い方
bunx @wato787/microcms-cli gen-types --all
環境変数は MICROCMS_SERVICE_DOMAIN と MICROCMS_MANAGEMENT_API_KEY の 2 つです。プロジェクト直下に .env または .env.local を置いていただければ読み込みます。--service-domain / --api-key で上書きも可能です。詳しくは README をご覧ください。