You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-playground/overview.mdx
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,15 @@ The API playground is an interactive environment that lets users test and explor
15
15
16
16
The playground is automatically generated from your OpenAPI specification or AsyncAPI schema so any updates to your API are automatically reflected in the playground. You can also manually create API reference pages after defining a base URL and authentication method in your `docs.json`.
17
17
18
-
We recommend generating your API playground with an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.
18
+
We recommend generating your API playground from an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.
19
19
20
20
## Getting started
21
21
22
22
<Steps>
23
23
<Steptitle="Add your OpenAPI specification file.">
24
-
You will need a valid OpenAPI specification file in your project.
24
+
<Info>
25
+
Make sure that your OpenAPI specification file is valid.
26
+
</Info>
25
27
26
28
```{2}
27
29
/your-project
@@ -72,9 +74,11 @@ You can customize your API playground by defining the following properties in yo
72
74
73
75
<ResponseFieldname="examples"type="object">
74
76
Configurations for the autogenerated API examples.
75
-
<Expandabletitle="Examples"defaultOpen="True">
77
+
<Expandabletitle="examples"defaultOpen="True">
76
78
<ResponseFieldname="languages"type="array of string">
77
79
Example languages for the autogenerated API snippets.
Whether to show optional parameters in API examples. Defaults to `all`.
@@ -98,7 +102,7 @@ You can customize your API playground by defining the following properties in yo
98
102
}
99
103
```
100
104
101
-
This example configures the API playground to be fully interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.
105
+
This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.
102
106
103
107
### Custom `MDX` pages
104
108
@@ -109,8 +113,8 @@ When you need more control over your API documentation, create individual `MDX`
109
113
- Hide specific operations
110
114
- Reorder pages in your navigation
111
115
112
-
See [MDX Setup](/api-playground/mdx/configuration.mdx) for more information on creating individual pages for your API endpoints.
116
+
See [MDX Setup](/api-playground/mdx/configuration) for more information on creating individual pages for your API endpoints.
113
117
114
118
## Further reading
115
119
116
-
-[AsyncAPI Setup](/api-playground/asyncapi/setup.mdx) for more information on creating your AsyncAPI schema to generate WebSocket reference pages.
120
+
-[AsyncAPI Setup](/api-playground/asyncapi/setup) for more information on creating your AsyncAPI schema to generate WebSocket reference pages.
0 commit comments