Leveraging your GraphQL API Interactive Documentation

Once you log into the Developer Portal, test your GraphQL API on the I/O Doc section.

Before you begin

Before testing GraphQL I/O Doc on Developer Portal, you must ensure the following:

• You have Developer Portal access as an app developer.
• The Control Center setup for your GraphQL API's authentication type has been completed:
  • Prerequisites for using API Key authenticated GraphQL I/O Doc
  • Prerequisites for using OAuth 2.0 authenticated GraphQL I/O Doc
  • Prerequisites for using Secure Hash (SHA-256 or MD5) authenticated GraphQL I/O Doc

Procedure

1. Sign in to Developer Portal and navigate to I/O Docs or in the address bar URL, enter /interactive-documentation to your client domain URL. For example, https://developer.<clientname>.com/interactive-documentation

   You should be able to view the API exposed to the selected developer role, based on the settings configured on the Interactive Documentation Access Control page available here.

2. Select the GraphQL I/O Doc from the Interactive Documentation selector list. The GraphQL editor automatically loads the GraphQL endpoint's schema and authentication settings and displays the available query fields fetched from the Control Center’s Key & Method Detection page.

3. If your schema requires authentication, provide the authentication values set in the Request Authentication Type and Developer’s API Key Location fields on the Key & Method Detection page.

4. In the Query Editor, select the fetched query fields to insert them into the query operation or write your GraphQL query or mutation.

5. Optional: In the Schema Explorer panel, click the Documentation Explorer to browse the available queries, mutations, subscriptions, fields, and data types.

   tip

   To learn about the GraphQL Editor panel and toolbar options, refer to GraphQL Editor.

6. Click Execute query. The editor sends the request to the server, and the response results appear on the right side of the interface.