File size: 1,986 Bytes
f37edb2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# API Playground user interface

Source: https://docs.rubrik.com/en-us/saas/gql/api_playground_ui.html

---

# API Playground user interface

The API Playground user interface in RSC uses the GraphiQL integrated development environment framework to run Rubrik GraphQL operations.

API Playground leverages the powerful user interface of the GraphiQL integrated development environment (IDE). Using the API Playground user interface, you can refer to the latest Rubrik GraphQL API documentation. The interface also provides an editor, which you can use to compose your queries and mutations, and a results area, where you can see the result of the API operation.

The following table describes the icons available on the user interface and the associated functionality. The Icon column refers to the icons using the text that appears when you hover over each icon.

Icon | Description  
---|---  
Show Documentation Explorer | 

  * Displays the Rubrik GraphQL documentation derived from the latest schema reference.
  * Provides a search option to search for specific queries and mutations.

  
Show History | Displays a list of GraphQL operations run using the API Playground user interface in the current browser session.  
Re-fetch GraphQL Schema | Refreshes the documentation with the latest Rubrik GraphQL schema reference, on demand.  
Open short keys dialog | Displays a list of keyboard shortcuts for frequently performed actions on the editor.  
Open settings dialog | Displays additional settings for the web page.  
Execute query | Runs the GraphQL query or mutation that is entered in the editor.  
Prettify query | Formats the content of the editor.  
Merge fragments into query | Merges fragments with the main query for ease of understanding and readability.  
Copy query | Copies the editor content to the clipboard.  
Add tab | Adds a tab to the editor.  
  
For more details about the GraphiQL IDE, refer to the official GraphiQL IDE documentation.
  *[ > ]: and then