OptiSigns APIはGraphQLを基盤として構成されています。GraphQLはAPI用のクエリ言語で、APIのデータの完全で理解しやすい説明を提供し、クライアントが必要なものだけを正確に要求できるようにし、時間の経過とともにAPIを進化させやすくし、強力な開発者ツールを実現します。
なぜGraphQLなのか
APIエンドポイントは1つだけ
GraphQL APIは、エンドポイントではなく、型とフィールドの観点から構成されています。単一のエンドポイントからデータの全機能にアクセスできます。GraphQLは型を使用して、アプリが可能なことだけを要求し、明確で役立つエラーを提供することを保証します。アプリは型を使用して、手動の解析コードの記述を回避できます。
単一のリクエストで多くのリソースを取得
GraphQLクエリは、1つのリソースのプロパティだけでなく、それらの間の参照もスムーズに辿ることができます。一般的なREST APIでは複数のURLからの読み込みが必要ですが、GraphQL APIはアプリが必要とするすべてのデータを単一のリクエストで取得します。GraphQLを使用するアプリは、遅いモバイルネットワーク接続でも高速に動作できます。
過剰な取得や不足な取得がない
APIにGraphQLクエリを送信すると、必要なものだけを正確に取得でき、それ以上でもそれ以下でもありません。GraphQLクエリは常に予測可能な結果を返します。GraphQLを使用するアプリは、サーバーではなく、取得するデータを制御するため、高速で安定しています。
バージョン管理が不要
既存のクエリに影響を与えることなく、新しいフィールドと型をGraphQL APIに追加できます。古いフィールドは非推奨にして、ツールから非表示にすることができます。単一の進化するバージョンを使用することで、GraphQL APIはアプリに新機能への継続的なアクセスを提供し、よりクリーンで保守しやすいサーバーコードを促進します。
OptiSigns APIエンドポイント
GraphQL APIは、以下のエンドポイントを使用してアクセスできます。
https://graphql-gateway.optisigns.com
また、APIにアクセスするためのWebベースのGraphQL IDEも提供しています。
https://graphql-gateway.optisigns.com/graphql
次の記事 - APIキーの生成と管理