Utilizar las ID de nodo global

Puedes acceder a la mayoría de objetos en GitHub (usuarios, informes de problemas, solicitudes de extracción, etc.) utilizando ya sea la API de Rest o la de GraphQL. Puedes encontrar el identificador de nodo global de muchos objetos desde la API REST y usar esos identificadores en las operaciones de GraphQL. Para más información, consulta Versión preliminar de los identificadores de nodo de GraphQL API en recursos de API REST.

Note

En REST, el campo de identificador de nodo global se denomina node_id. En GraphQL, es un campo de id en la interfaz de node. Para repasar el significado de "nodo" en GraphQL, consulta Introducción a GraphQL.

Darle uso a las ID de nodo global

Puedes seguir estos tres pasos para utilizar las ID de nodo global efectivamente:

Llame a un punto de conexión de REST que recupere el node_id de un objeto.
Encuentra el tipo del objeto en GraphQL.
Utiliza la ID y tipo para hacer una búsqueda directa de nodo en GraphQL.

Revisemos un ejemplo.

1. Llame a un punto de conexión de REST que recupere el identificador de nodo de un objeto

Si solicita el usuario autenticado:

curl -i --header "Authorization: Bearer YOUR-TOKEN" http(s)://HOSTNAME/api/v3/user

obtendrá una respuesta que incluye el node_id del usuario autenticado:

{
  "login": "octocat",
  "id": 1,
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  "followers_url": "https://api.github.com/users/octocat/followers",
  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
  "organizations_url": "https://api.github.com/users/octocat/orgs",
  "repos_url": "https://api.github.com/users/octocat/repos",
  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
  "received_events_url": "https://api.github.com/users/octocat/received_events",
  "type": "User",
  "site_admin": false,
  "name": "monalisa octocat",
  "company": "GitHub",
  "blog": "https://github.com/blog",
  "location": "San Francisco",
  "email": "octocat@github.com",
  "hireable": false,
  "bio": "There once was...",
  "public_repos": 2,
  "public_gists": 1,
  "followers": 20,
  "following": 0,
  "created_at": "2008-01-14T04:33:35Z",
  "updated_at": "2008-01-14T04:33:35Z",
  "private_gists": 81,
  "total_private_repos": 100,
  "owned_private_repos": 100,
  "disk_usage": 10000,
  "collaborators": 8,
  "two_factor_authentication": true,
  "plan": {
    "name": "Medium",
    "space": 400,
    "private_repos": 20,
    "collaborators": 0
  },
  "node_id": "MDQ6VXNlcjU4MzIzMQ=="
}

2. Encuentre el tipo de objeto en GraphQL

En este ejemplo, el valor de node_id es MDQ6VXNlcjU4MzIzMQ==. Puedes utilizar este valor para consultar el mismo objeto en GraphQL.

Sin embargo, deberá conocer primero el tipo de objeto. Puedes revisar el tipo con una consulta simple de GraphQl:

query {
  node(id:"MDQ6VXNlcjU4MzIzMQ==") {
     __typename
  }
}

Este tipo de consulta,—es decir, buscar el nodo por id.—, se conoce como "búsqueda directa de nodo".

Al ejecutar esta consulta, verá que __typename es User.

3. Realice una búsqueda directa de nodo en GraphQL

Una vez que haya confirmado el tipo, puede usar un fragmento alineado para acceder al objeto por su identificador y devolver datos adicionales. En este ejemplo, definimos los campos de User que nos gustaría consultar:

query {
  node(id:"MDQ6VXNlcjU4MzIzMQ==") {
   ... on User {
      name
      login
    }
  }
}

Este tipo de consulta es el acercamiento estándar para buscar un objeto por su ID de nodo global.