Skip to content

Latest commit

 

History

History
84 lines (68 loc) · 3.82 KB

comparing-githubs-rest-api-and-graphql-api.md

File metadata and controls

84 lines (68 loc) · 3.82 KB
Raw
title shortTitle intro redirect_from versions topics
Comparing GitHub's REST API and GraphQL API
Comparing GitHub's APIs
Learn about {% data variables.product.prodname_dotcom %}'s APIs to extend and customize your {% data variables.product.prodname_dotcom %} experience.
/v3/versions
/articles/getting-started-with-the-api
/github/extending-github/getting-started-with-the-api
/developers/overview/about-githubs-apis
/rest/overview/about-githubs-apis
/rest/overview/comparing-githubs-rest-api-and-graphql-api
fpt ghes ghec
*
*
*
API

About {% data variables.product.company_short %}'s APIs

{% data variables.product.company_short %} provides two APIs: a REST API and a GraphQL API. You can interact with both APIs using {% data variables.product.prodname_cli %}, curl, the official Octokit libraries, and third party libraries. Occasionally, a feature may be supported on one API but not the other.

You should use the API that best aligns with your needs and that you are most comfortable using. You don't need to exclusively use one API over the other. Node IDs let you move between the REST API and GraphQL API. For more information, see "AUTOTITLE."

This article discusses the benefits of each API. For more information about the GraphQL API, see "AUTOTITLE." For more information about the REST API, see "AUTOTITLE".

Choosing the GraphQL API

The GraphQL API returns exactly the data that you request. GraphQL also returns the data in a pre-known structure based on your request. In contrast, the REST API returns more data than you requested and returns it in a pre-determined structure. You can also accomplish the equivalent of multiple REST API request in a single GraphQL request. The ability to make fewer requests and fetch less data makes GraphQL appealing to developers of mobile applications.

For example, to get the {% data variables.product.product_name %} login of ten of your followers, and the login of ten followers of each of your followers, you can send a single request like:

{
  viewer {
    followers(first: 10) {
      nodes {
        login
        followers(first: 10) {
          nodes {
            login
          }
        }
      }
    }
  }
}

The response will be a JSON object that follows the structure of your request.

In contrast, to get this same information from the REST API, you would need to first make a request to GET /user/followers. The API would return the login of each follower, along with other data about the followers that you don't need. Then, for each follower, you would need to make a request to GET /users/{username}/followers. In total, you would need to make 11 requests to get the same information that you could get from a single GraphQL request, and you would receive excess data.

Choosing the REST API

Because REST APIs have been around for longer than GraphQL APIs, some developers are more comfortable with the REST API. Since REST APIs use standard HTTP verbs and concepts, many developers are already familiar with the basic concepts to use the REST API.

For example, to create an issue in the octocat/Spoon-Knife repository, you would need to send a request to POST /repos/octocat/Spoon-Knife/issues with a JSON request body:

{
  "title": "Bug with feature X",
  "body": "If you do A, then B happens"
}

In contrast, to make an issue using the GraphQL API, you would need to get the node ID of the octocat/Spoon-Knife repository and then send a request like:

mutation {
  createIssue(
    input: {
      repositoryId: "MDEwOlJlcG9zaXRvcnkxMzAwMTky"
      title: "Bug with feature X"
      body: "If you do A, then B happens"}
  ) {
    issue {
      number
      url
    }
  }
}