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. Con una actualización reciente, puedes encontrar la ID de nodo global de muchos objetos desde dentro de la API de REST y utilizar estas ID en tus operaciones de GraphQL.

Darle uso a las ID de nodo global

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

1. Llama a una terminal de REST que recupere el node_id de un objeto.
2. Encuentra el tipo del objeto en GraphQL.
3. Utiliza la ID y tipo para hacer una búsqueda directa de nodo en GraphQL.

Revisemos un ejemplo.

1. Llama a una terminal de REST que recupere la ID de nodo de un objeto

Si solicitas el usuario autenticado:

$ curl -i -u username:token http(s)://[hostname]/api/v3/user

obtendrás 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. Encuentra 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.

Aunque necesitas saber el tipo del objeto primero. Puedes revisar el tipo con una consulta simple de GraphQl:

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

Este tipo de consulta —que es encontrar el nodo por ID— se conoce como "búsqueda directa de nodo".

Cuando ejecutas esta consulta, encontrarás que el __typename es User.

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

Una vez que hayas confirmado el tipo, puedes utilizar un fragmento dentro de la línea para acceder al objeto por su ID y recuperar datos adicionales. En este ejemplo, definimos los campos que queremos consultar en User:

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.

Utilizar las ID de nodo global en migraciones

Cuando construyes integraciones que utilizan ya sea la API de REST o de GraphQL, la mejor práctica es persistir la ID de nodo global para que puedas referenciar fácilmente los objetos a través de las versiones de las API. Para obtener más información sobre cómo llevar a cabo la transición entre REST y GraphQL, consulta la sección "Migrar de REST a GraphQL".