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/mdx/configuration.mdx
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,19 @@ title: 'MDX Setup'
3
3
description: 'Generate docs pages for your API endpoints using MDX'
4
4
---
5
5
6
-
Mintlify allows you to define your API endpoints using a combination of `mint.json` configuration, MDX metadata fields, and the `<ParamFields />` component. From the defined endpoints, we generate an API playground, request examples, and response examples.
6
+
Mintlify allows you to define your API endpoints using a combination of `docs.json` configuration, MDX metadata fields, and the `<ParamFields />` component. From the defined endpoints, we generate an API playground, request examples, and response examples.
7
7
8
8
<Steps>
9
9
<Steptitle="Configure your API">
10
-
In your `mint.json` file, define your base URL and auth method:
10
+
In your `docs.json` file, define your base URL and auth method:
11
11
12
12
```json
13
-
{
14
-
"api": {
15
-
"baseUrl": "https://mintlify.com/api", // string array for multiple base URLs
13
+
"api": {
14
+
"mdx": {
15
+
"server": "https://mintlify.com/api", // string array for multiple base URLs
@@ -23,16 +24,14 @@ Mintlify allows you to define your API endpoints using a combination of `mint.js
23
24
If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field:
24
25
25
26
```json
26
-
{
27
-
"api": {
28
-
"playground": {
29
-
"mode": "hide"
30
-
}
27
+
"api": {
28
+
"playground": {
29
+
"display": "none"
31
30
}
32
31
}
33
32
```
34
33
35
-
Find a full list of API configurations [here](/settings/global#api-configurations).
34
+
Find a full list of API configurations [here](/settings/global#param-api).
36
35
</Step>
37
36
38
37
<Steptitle="Create your endpoint pages">
@@ -54,12 +53,12 @@ Mintlify allows you to define your API endpoints using a combination of `mint.js
54
53
55
54
<Note>
56
55
57
-
If you have `baseUrl` configured in [mint.json](/settings/global), you can use relative paths like `/v1/endpoint`.
56
+
If you have `server` configured in [docs.json](/settings/global), you can use relative paths like `/v1/endpoint`.
58
57
59
58
</Note>
60
59
</Step>
61
60
62
61
<Steptitle="Add your endpoints to your docs">
63
-
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `mint.json`. Learn more about structuring your docs [here](/settings/navigation).
62
+
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](/settings/navigation).
The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor.
15
+
The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `docs.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor.
0 commit comments