本文へスキップ

APIスキーマ

一般的なケースの場合、Delivery Trackerのホームページ内の各種ドキュメントに記載されている基本的なRequest例を参考にしたり、そのまま使用することで、GraphQLに慣れていなくても簡単に使い方を習得することができます。

**上級者向けの追加説明

Delivery Tracker は、一般的なケース以外の上級ユーザー向けに GraphQL API Schema を提供しています。

これにより、様々なAPIを作成したい場合は、まずGraphQLについて知っておく必要があります。 GraphQLに慣れていない場合は、https://graphql-kr.github.io/learn/ のようなドキュメントを参照してください。

API スキーマのダウンロード

GraphQL イントロスペクション

Delivery Tracker は GraphQL Introspection を通じて Schema を提供しています。

様々なクライアントライブラリでGraphQL Introspectionを通じたスキーマのダウンロードを提供しており、これによりSchemaをダウンロードしてCodegenを使用することができます。

ヒント

Schema Download時にも認証が必要です。 Downloadにエラーが発生する場合、Authorizationヘッダーがうまく注入されているか確認してください。