...
Differences in API logic
Migrating from REST to GraphQL represents a significant shift in API logic. The differences between REST as a style and GraphQL as a specification make it difficult—and often undesirable—to replace REST API calls with GraphQL API queries on a one-to-one basis. We've included specific examples of migration below.
...
Here are examples of each.
Example #1: Getting the data you need, and nothing more
A single REST API call retrieves a list of your organization's members:
...
| Code Block |
|---|
query {
viewer {
organization {
members(first: 10) {
edges {
node {
name
avatar {
fileUrl
}
}
}
}
}
}
}
|
Example #2: Nesting
Querying with nested fields lets you replace multiple REST calls with fewer GraphQL queries. For example, retrieving a scenario along with its ar contents and associated groups using the REST API requires four separate calls:
...
You can also extend the power of this query by substituting a variable for the pull request number.
Example #3: Strong typing
GraphQL schemas are strongly typed, making data handling safer.
...