Skip to content

Commit 1d5eccc

Browse files
authored
Merge pull request #25414 from microsoftgraph/ImproveGETutorial
Improving GE tutorial
2 parents 7f00eea + 647f697 commit 1d5eccc

6 files changed

+89
-30
lines changed

concepts/graph-explorer/graph-explorer-overview.md

Lines changed: 89 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,117 @@
22
title: Use Graph Explorer to try Microsoft Graph APIs
33
description: Try Microsoft Graph APIs on the default sample tenant to explore capabilities, or sign in to your tenant and use it as a prototyping tool to fulfill your app scenarios.
44
ms.localizationpriority: high
5-
author: RabebOthmani
5+
author: wujessica
66
---
77

88
# Use Graph Explorer to try Microsoft Graph APIs
99

10-
[Graph Explorer](https://developer.microsoft.com/graph/graph-explorer/) is a developer tool that lets you learn about Microsoft Graph APIs. Use Graph Explorer to try the APIs on the default sample tenant to explore capabilities, or sign in to your own tenant and use it as a prototyping tool to fulfill your app scenarios. This tool includes helpful features such as code snippets (C#, Java, JavaScript, Go and PowerShell), Microsoft Graph Toolkit and adaptive cards integration, and more.
10+
[Graph Explorer](https://developer.microsoft.com/graph/graph-explorer/) is a developer tool for exploring Microsoft Graph APIs. Use it to:
1111

12-
:::image type="content" source="./images/graph-explorer-screen.png" alt-text="Screenshot of the Graph Explorer user interface." border="true":::
12+
- Test APIs on a sample tenant and explore available resources.
13+
- Sign in to your own tenant for prototyping app scenarios.
14+
- Learn about the permissions required for different APIs.
15+
- Explore Microsoft Graph Toolkit components, adaptive cards, and code snippets for queries.
1316

14-
Use Graph Explorer to:
17+
To get started, go to [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer/) in your browser.
1518

16-
- Try out Microsoft Graph APIs.
17-
- Learn about the permissions required for the different APIs.
18-
- Explore all the resources available on Microsoft Graph.
19-
- Explore Microsoft Graph Toolkit components, adaptive cards and code snippets for your queries.
19+
## Explore a sample query
2020

21-
Graph Explorer handles the authentication process for you. Customize the experience by collapsing the sidebar or changing the theme.
21+
You can run the prebuilt sample queries to see how the API works. Select any sample query, such as **Get my profile**, to see the request and response.
2222

23-
## Get started
23+
:::image type="content" source="./images/GE-tutorial-step2-explore-sample-query.png" alt-text="Screenshot of the Graph Explorer UI, which displays the returned results of the GET my profile query." border="true":::
2424

25-
Graph Explorer is a web application hosted on the [Microsoft Graph developer center](https://developer.microsoft.com/graph). It's an open-source project, and we welcome your contributions and feedback on [GitHub](https://github.com/microsoftgraph/microsoft-graph-explorer-v4).
25+
## Sign in for more features
2626

27-
### Make requests
27+
You can use Graph Explorer without signing in. Users who sign in can access their own tenants and perform more advanced operations. To try POST, PUT, PATCH, and DELETE requests, sign in with your Microsoft 365 account.
2828

29-
With Graph Explorer, you can make requests to the Microsoft Graph APIs to retrieve, add, delete and update data. Your requests can send parameters, authorization details, and any body data you require.
29+
We recommend signing into your [Microsoft 365 Developer sandbox tenant](https://developer.microsoft.com/en-US/microsoft-365/dev-program) instead of your production tenant to avoid running operations that can affect your production data.
3030

31-
:::image type="content" source="./images/request-headers.png" alt-text="Screenshot of request headers in Graph Explorer." border="true":::
31+
> [!IMPORTANT]
32+
> If you choose to sign in with your organizational account, running any write request in Graph Explorer might affect the data in the tenant.
3233
33-
## Retrieve data in Graph Explorer
34+
## Run your first query
3435

35-
To run a GET request in Graph Explorer, you don't have to sign in. You can retrieve sample data from the default sample tenant.
36+
To run a query in Graph Explorer:
3637

37-
:::image type="content" source="./images/get-request.png" alt-text="Screenshot of a sample request in Graph Explorer." border="true":::
38+
1. Select a sample query or type your query in the request field.
39+
1. Edit the request body and request headers as needed for the query.
40+
For example, to run a Post request, select POST in the drop-down list for the HTTP verb, and add a request body and request headers as appropriate.
41+
1. Select **Run query**.
42+
The response is displayed in the Response preview section. It includes the HTTP status code and the data returned by the API.
43+
1. Next to the Response preview tab, you can also view the response headers, code snippets, Toolkit components, and Adaptive cards that are relevant to the query.
3844

39-
To create the request, you can either select a sample query from the menu at the left, which fills in the query field, or you can choose to manually type your request in the field.
40-
Once you run the request, you will get the HTTP response code and the response will be displayed in the response preview area.
45+
:::image type="content" source="./images/GE-tutorial-step4-run-query.png" alt-text="Screenshot of Graph Explorer running a POST query to create a new application." border="true":::
4146

42-
When you sign in to Graph Explorer and run the same query, the response is returned with real data from the tenant that you signed in to.
47+
## Modify permissions
4348

44-
## Modify data in Graph Explorer
49+
Some queries require specific permissions. If a query fails due to insufficient permissions, you see an error message. To consent to permissions:
4550

46-
To try POST, PUT, PATCH, and DELETE requests, sign in to Graph Explorer by using a Microsoft 365 account. This can be an organizational account for testing or demonstration purposes. If you don't have a Microsoft 365 tenant, you might qualify for one through the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program); for details, see the [FAQ](/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-). Alternatively, you can [sign up for a 1-month free trial or purchase a Microsoft 365 plan](https://www.microsoft.com/en-us/microsoft-365/try).
51+
1. Select the **Modify permissions** to consent to the required permissions.
52+
1. Run the query again.
53+
1. You can also select the profile avatar and choose **Consent to permissions**. From the list of all available permissions, consent to the ones you want.
4754

48-
> [!IMPORTANT]
49-
> If you choose to sign in by using your organizational account, running a non-GET request might affect the data in the tenant.
55+
:::image type="content" source="./images/GE-tutorial-step5-modify-permissions.png" alt-text="Screenshot of the Modify permissions tab in Graph Explorer." border="true":::
56+
57+
## Find the right API for your application
58+
59+
Use the **Resources** tab and the documentation feature to find the right API for your application.
60+
61+
### Resources tab
62+
63+
Use the **Resources** tab to browse a list of Microsoft Graph resources in the beta and v1.0 endpoints or use the search bar to search for a specific resource.
64+
65+
You can also select specific queries to add to your collection. When you're finished adding resources, choose **Preview collection**. From the collection view, you can review, remove, and download the resources you selected.
66+
67+
:::image type="content" source="./images/GE-tutorial-resources.png" alt-text="On the left is a screenshot of the Resources tab in Graph Explorer. The right side displays the Preview collection panel. " border="true":::
68+
69+
### Documentation links
70+
71+
Select **Documentation** on each query to learn more about the API endpoint. The relevant API reference provides more information about the request parameters, response structure, and required permissions.
72+
73+
## Integrate Microsoft Graph APIs into your application
74+
75+
Use the following features in Graph Explorer to integrate Microsoft Graph APIs into your application.
76+
77+
### Code snippets
78+
79+
After running a query, select the **Code snippets** tab to see how to perform the same operation in your preferred language (C#, JavaScript, Java, Go, PowerShell).
80+
81+
:::image type="content" source="./images/GE-tutorial-code-snippets.png" alt-text="Screenshot of the code snippets tab in Graph Explorer." border="true":::
82+
83+
### Toolkit component
84+
85+
[Microsoft Graph Toolkit](../toolkit/overview.md) provides reusable, framework-agnostic web components and helpers that have built-in providers that authenticate with and fetch data from Microsoft Graph.
86+
87+
The toolkit component in Graph Explorer allows you to visualize Microsoft Graph Toolkit components that correspond to the API queries. A blue dot on the toolkit component tab indicates an available component for the currently specified REST API query. You can conveniently copy the code for the component to your app.
88+
89+
:::image type="content" source="./images/toolkit-screenshot.png" alt-text="Screenshot of the Microsoft Graph Toolkit tab in Graph Explorer." border="false":::
90+
91+
### Adaptive cards
92+
93+
[Adaptive cards](https://adaptivecards.io/) provide platform-agnostic snippets of UI, authored in JSON, that apps and services can openly exchange. A blue dot on the adaptive cards tab indicates that an adaptive card is available for the selected query.
94+
95+
:::image type="content" source="./images/adaptive-cards-screenshot.png" alt-text="Screenshot of the adaptive cards tab in Graph Explorer with the response details highlighted." border="false":::
96+
97+
## More Graph Explorer features
98+
99+
To help you make the most of Graph Explorer, familiarize yourself with the following additional features of the tool.
100+
101+
### History
102+
103+
Select **History** to access and export queries run over the past 30 days.
104+
105+
:::image type="content" source="./images/history-tab-screenshot.png" alt-text="Screenshot of the history tab in Graph Explorer.":::
106+
107+
### Settings
108+
109+
You can customize the Graph Explorer UI by using the settings icon at the top right. You can also expand, collapse, or resize the sidebar.
50110

51-
For example, to run a POST request, select POST in the drop-down list for the HTTP verb, and add a request body and request headers as appropriate.
111+
### Share
52112

53-
:::image type="content" source="./images/post-request.png" alt-text="Screenshot of a POST request in Graph Explorer." border="true":::
113+
To share your current query, select **Share** so people can try out the specific query in Graph Explorer.
54114

55-
## Next steps
115+
## Related content
56116

57-
- Try [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer/).
58-
- Explore the different [Graph Explorer features](./graph-explorer-features.md).
59-
- Contribute or provide feedback on [GitHub](https://github.com/microsoftgraph/microsoft-graph-explorer-v4/issues/new/choose).
117+
- [Work with Graph Explorer](./graph-explorer-features.md)
118+
- [Contribute or provide feedback on GitHub](https://github.com/microsoftgraph/microsoft-graph-explorer-v4/issues/new/choose)
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)