[GraphQL] Updating docs with GraphQL Explorer retirement (#57163)

Co-authored-by: Johanan <[email protected]>
Co-authored-by: Ben Ahmady <[email protected]>

Author: 3 people

content/graphql/guides/forming-calls-with-graphql.md

@@ -49,7 +49,7 @@ If you access {% data variables.product.github %} at a different domain, such as
 
 ## Communicating with GraphQL
 
-Because GraphQL operations consist of multiline JSON, GitHub recommends using the [Explorer](/graphql/guides/using-the-explorer) to make GraphQL calls. You can also use `curl` or any other HTTP-speaking library.
+Because GraphQL operations consist of multiline JSON, GitHub recommends using the [GraphQL Clients](/graphql/guides/using-graphql-clients) to make GraphQL calls. You can also use `curl` or any other HTTP-speaking library.
 
 In REST, [HTTP verbs](/rest#http-verbs) determine the operation performed. In GraphQL, you'll provide a JSON-encoded body whether you're performing a query or a mutation, so the HTTP verb is `POST`. The exception is an [introspection query](/graphql/guides/introduction-to-graphql#discovering-the-graphql-api), which is a simple `GET` to the endpoint. For more information on GraphQL versus REST, see [AUTOTITLE](/graphql/guides/migrating-from-rest-to-graphql).
 

content/graphql/guides/index.md

@@ -14,7 +14,7 @@ children:
   - /forming-calls-with-graphql
   - /using-global-node-ids
   - /migrating-from-rest-to-graphql
-  - /using-the-explorer
+  - /using-graphql-clients
   - /using-pagination-in-the-graphql-api
   - /managing-enterprise-accounts
   - /using-the-graphql-api-for-discussions

content/graphql/guides/managing-enterprise-accounts.md

@@ -39,10 +39,7 @@ For a list of the fields available with the Enterprise Accounts API, see [AUTOTI
 
 ## Getting started using GraphQL for enterprise accounts
 
-Follow these steps to get started using GraphQL to manage your enterprise accounts:
-* Authenticating with a {% data variables.product.pat_generic %}
-* Choosing a GraphQL client or using the GraphQL Explorer
-* Setting up Insomnia to use the GraphQL API
+See [AUTOTITLE](/graphql/guides/using-graphql-clients) to get started using GraphQL to manage your enterprise accounts.
 
 For some example queries, see [An example query using the Enterprise Accounts API](#an-example-query-using-the-enterprise-accounts-api).
 
@@ -206,5 +203,5 @@ For more information about getting started with GraphQL, see [AUTOTITLE](/graphq
 
 For more details about the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API, see the sidebar with detailed GraphQL definitions from any [GraphQL reference page](/graphql).
 
-You can access the reference docs from within the GraphQL explorer on GitHub. For more information, see [AUTOTITLE](/graphql/guides/using-the-explorer#accessing-the-sidebar-docs).
+You can access the reference docs from within the GraphQL clients. For more information, see [AUTOTITLE](/graphql/guides/using-graphql-clients).
 For other information, such as authentication and rate limit details, check out the [guides](/graphql/guides).

content/graphql/guides/using-graphql-clients.md

@@ -0,0 +1,74 @@
+---
+title: Using GraphQL Clients
+intro: 'You can run queries on real {% data variables.product.prodname_dotcom %} data using various GraphQL clients and libraries.'
+redirect_from:
+  - /v4/guides/using-the-explorer
+  - /graphql/guides/using-the-explorer
+versions:
+  fpt: '*'
+  ghec: '*'
+  ghes: '*'
+topics:
+  - API
+---
+
+## Using GraphQL client IDEs
+
+There are many open-source GraphQL client IDEs you can use to access {% data variables.product.company_short %}'s GraphQL API.
+
+See [AUTOTITLE](/graphql/guides/forming-calls-with-graphql) for extensive information on HTTP methods, authentication, and GraphQL call structure.
+
+First, choose a client. Common options include GraphiQL, Insomnia, and Altair (desktop/web/extension). You can see the full list of clients in the [GraphQL organization's tool directory](https://graphql.org/community/tools-and-libraries/?tags=services).
+
+The following generic instructions will work with most GraphQL clients:
+1. Point the client at the GraphQL endpoint: `{% data variables.product.graphql_url %}`.
+1. Add an `Authorization` header: `Authorization: Bearer TOKEN` (replace `TOKEN` with your {% data variables.product.company_short %} {% data variables.product.pat_generic %}. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
+1. Set the request method to `POST` or if it's available, use the client-provided GraphQL mode.
+1. Enter your query or mutation in the editor and, if needed, provide variables in the "Variables" panel.
+
+   Example:
+
+   ```graphql
+   query {
+     viewer {
+       login
+     }
+   }
+   ```
+
+1. If your client needs a schema for documentation rendering or autocomplete, fetch it via a GraphQL introspection query. Many clients can do this automatically from the "Docs" panel.
+
+   Minimal introspection query:
+
+   ```graphql
+   query IntrospectionQuery {
+     __schema {
+       types {
+         name
+       }
+     }
+   }
+   ```
+
+1. Run the request and inspect the JSON response. Query from example should return the login associated with the {% data variables.product.company_short %} {% data variables.product.pat_generic %} you authenticated with.
+
+Use the client UI to explore docs, run queries, and save requests as needed.
+
+## {% data variables.product.prodname_cli %}
+
+You can also use the command line with {% data variables.product.prodname_cli %} to run GraphQL queries.
+
+1. Install and [authenticate with {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_auth_login).
+1. Run a query against `{% data variables.product.graphql_url %}` using the GraphQL endpoint with the [`gh api` subcommand](https://cli.github.com/manual/gh_api).
+
+Example:
+
+```shell
+gh api graphql -f query='query { viewer { login } }'
+```
+
+This should return the login associated with the {% data variables.product.company_short %} {% data variables.product.pat_generic %} you authenticated with.
+
+## Requesting support
+
+{% data reusables.support.help_resources %}

content/graphql/guides/using-the-explorer.md

@@ -8,7 +8,7 @@ featuredLinks:
   startHere:
     - /graphql/guides/forming-calls-with-graphql
     - /graphql/guides/introduction-to-graphql
-    - /graphql/guides/using-the-explorer
+    - /graphql/guides/using-graphql-clients
   popular:
     - /graphql/overview/explorer
     - /graphql/overview/public-schema

content/graphql/index.md

@@ -13,7 +13,15 @@ topics:
 autogenerated: graphql
 ---
 
-For more information about how to use the explorer, see [AUTOTITLE](/graphql/guides/using-the-explorer).
+<!-- expires 2025-11-01 -->
+<!-- We should change this to a note describing what's happened once the date is reached. -->
+
+> [!WARNING]
+> The GraphQL Explorer as an embedded tool will be removed from the documentation on November 1, 2025. See our [changelog announcement](https://github.blog/changelog/2025-08-22-graphql-explorer-removal-from-api-documentation-on-november-1-2025).
+
+For more information about how to explore {% data variables.product.prodname_dotcom %} GraphQL Schema, see [AUTOTITLE](/graphql/guides/using-graphql-clients).
+
+<!-- end expires 2025-11-01 -->
 
 {% ifversion ghec %}
 

content/graphql/overview/explorer.md

@@ -13,7 +13,7 @@ shortTitle: Sponsors GraphQL API
 
 To get started with the GraphQL API, see [AUTOTITLE](/graphql/guides/introduction-to-graphql).
 
-You can find the details about the Sponsors GraphQL API in the reference docs. For more information, see [AUTOTITLE](/graphql/reference). We recommend using the GraphQL explorer to build your GraphQL calls. For more information, see [AUTOTITLE](/graphql/guides/using-the-explorer).
+You can find the details about the Sponsors GraphQL API in the reference docs. For more information, see [AUTOTITLE](/graphql/reference). We recommend using the GraphQL clients to build your GraphQL calls. For more information, see [AUTOTITLE](/graphql/guides/using-graphql-clients).
 
 ## Known Issues