GraphQL

データを記述する

type Project {
  name: String
  tagline: String
  contributors: [User]
}

必要なものを要求する

{
  project(name: "GraphQL") {
    tagline
  }
}

予測可能な結果を得る

{
  "project": {
    "tagline": "A query language for APIs"
  }
}

始めましょう詳しくはこちら

あなたのAPIのためのクエリ言語

GraphQLはAPIのためのクエリ言語であり、既存のデータでそれらのクエリを満たすためのランタイムです。GraphQLは、API内のデータの完全で理解可能な記述を提供し、クライアントが必要なものを正確に要求する力を与え、APIを時間の経過とともに進化させることを容易にし、強力な開発者ツールを可能にします。

必要なものを要求して、
まさにそれを手に入れる

GraphQLクエリをAPIに送信して、必要なものを正確に取得し、それ以上でもそれ以下でもありません。GraphQLクエリは常に予測可能な結果を返します。GraphQLを使用するアプリは、サーバーではなく取得するデータを制御するため、高速で安定しています。

多くのリソースを
単一のリクエストで取得する

GraphQLクエリは、1つのリソースのプロパティだけでなく、それらの間の参照もスムーズに追跡します。一般的なREST APIでは複数のURLからロードする必要がある一方、GraphQL APIはアプリに必要なすべてのデータを1つのリクエストで取得します。GraphQLを使用するアプリは、モバイルネットワークの接続が遅くても高速に動作します。

可能なことを記述する
型システムで

GraphQL APIは、エンドポイントではなく、型とフィールドの観点から編成されています。単一のエンドポイントからデータのすべての機能にアクセスします。GraphQLは型を使用して、アプリが必要なものだけを要求し、明確で役立つエラーを提供できるようにします。アプリは型を使用して、手動での解析コードの記述を回避できます。

{
  hero {
    name
    friends {
      name
      homeWorld {
        name
        climate
      }
      species {
        name
        lifespan
        origin {
          name
        }
      }
    }
  }
}

type Query {
  hero: Character
}

type Character {
  name: String
  friends: [Character]
  homeWorld: Planet
  species: Species
}

type Planet {
  name: String
  climate: String
}

type Species {
  name: String
  lifespan: Int
  origin: Planet
}

より速く動く
強力な開発者ツールで

エディターを離れることなく、APIからリクエストできるデータを正確に把握し、クエリを送信する前に潜在的な問題を強調表示し、改善されたコードインテリジェンスを活用します。GraphQLを使用すると、次のような強力なツールを簡単に構築できます。 GraphiQL APIの型システムを活用して。

APIを進化させる
バージョンなしで

既存のクエリに影響を与えることなく、GraphQL APIに新しいフィールドと型を追加します。古いフィールドは非推奨にして、ツールから非表示にすることができます。GraphQL APIは、単一の進化するバージョンを使用することで、アプリが新しい機能に継続的にアクセスできるようにし、よりクリーンで保守しやすいサーバーコードを促進します。

type Film {
  title: String
  episode: Int
  releaseDate: String



}

type Film {
  title: String
  episode: Int
  releaseDate: String
  openingCrawl: String


}

type Film {
  title: String
  episode: Int
  releaseDate: String
  openingCrawl: String
  director: String
  
}

type Film {
  title: String
  episode: Int
  releaseDate: String
  openingCrawl: String
  director: String
  directedBy: Person
}

type Person {
  name: String
  directed: [Film]
  actedIn: [Film]
}

type Film {
  title: String
  episode: Int
  releaseDate: String
  openingCrawl: String
  director: String @deprecated
  directedBy: Person
}

type Person {
  name: String
  directed: [Film]
  actedIn: [Film]
  
}

あなた自身の
データとコードを持ち込む

GraphQLは、特定のストレージエンジンに制限されることなく、アプリケーション全体で統一されたAPIを作成します。多くの言語で利用可能なGraphQLエンジンを使用して、既存のデータとコードを活用するGraphQL APIを作成します。型システム内の各フィールドに関数を提供すると、GraphQLはそれらを最適な並行性で呼び出します。

type Character {
 name: String
 homeWorld: Planet
 friends: [Character]
}

// type Character {
class Character {
 // name: String
 getName() {
 return this._name
 }
 
 // homeWorld: Planet
 getHomeWorld() {
 return fetchHomeworld(this._homeworldID)
 }
 
 // friends: [Character]
 getFriends() {
 return this._friendIDs.map(fetchCharacter)
 }
}

# type Character {
class Character:
 # name: String
 def name(self):
 return self._name
 
 # homeWorld: Planet
 def homeWorld(self):
 return fetchHomeworld(self._homeworldID)
 
 # friends: [Character]
 def friends(self):
 return map(fetchCharacter, self._friendIDs)

 
// type Character {
public class Character {
 // name: String
 public String Name { get; }
 
 // homeWorld: Planet
 public async Task<Planet> GetHomeWorldAsync() {
 return await FetchHomeworldAsync(_HomeworldID);
 }
 
 // friends: [Character]
 public async IEnumerable<Task<Character>> GetFriendsAsync() {
 return _FriendIDs.Select(FetchCharacterAsync);
 }
}