# Shopify GraphQL Storefront APIのバージョンごとのスキーマファイルの取得方法

> Shopify GraphQL Storefront APIの各バージョンのスキーマファイルを取得する方法と、破壊的変更への対応について解説したガイドです。

- 公開日: 2025-03-28
- 著者: Tsukamura
- タグ: Shopify
- URL: https://tech.anycloud.co.jp/articles/update-storefront-api

---

[Shopify Storefront API](https://shopify.dev/docs/api/storefront)は定期的にアップデートされ、新機能の追加や既存機能の改善が行われています。開発者がこのAPIを利用するアプリケーションを最新バージョンに対応させるためには、各バージョンのGraphQLスキーマを取得する必要があります。 この記事では、Shopify Storefront GraphQL APIの各バージョンのスキーマファイルを取得する方法について解説します。

## **GraphQLスキーマファイルの取得方法**

Shopify Storefront APIの特定バージョンのGraphQLスキーマを取得するには、以下の手順に従います

1.  [get-graphql-schema](https://github.com/prisma-labs/get-graphql-schema) パッケージをインストールします
    
    ```shell
    npm install -g get-graphql-schema
    ```
    
2.  以下のコマンドを実行して特定バージョンのGraphQLスキーマを取得します
    
    ```shell
    get-graphql-schema <https://$>{shop-name}.myshopify.com/api/${api-version}/graphql.json/ > schema.graphql -h "X-Shopify-Storefront-Access-Token=${token}"
    ```
    
    このコマンドでは、以下の情報を指定する必要があります
    
    -   ${shop-name}: ストアの名前（例: ⁠mystore）
    -   ⁠${api-version}: 取得したいAPIのバージョン（例: ⁠2024-10）
    -   ⁠${token}: Shopify Storefront Access Token
    
    コマンドを実行すると、指定したバージョンのGraphQLスキーマが⁠schema.graphqlファイルに保存されます。
    
3.  スキーマファイル更新後にすること
    
    スキーマファイルを更新したバージョンアップデートには、破壊的変更が含まれることがあります。これらの変更がアプリケーションに影響を与える可能性があるため、適切に対応する必要があります。
    
    1.  [Shopify APIのリリースノート](https://shopify.dev/docs/api/release-notes)を確認し、新しいバージョンでの変更点を把握します
    2.  破壊的変更がある場合は、アプリケーションコードを適宜修正します

## **おわりに**

この記事で紹介した方法を活用しAPIのバージョン管理をスムーズに行い、最新機能を取り入れながらも安定したShopifyアプリケーション開発を！(｀･ω･´)