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
API pages are complicated. As a result, there are a lot of things that can go wrong. Here's a list of common issues we've seen customers run into:
39
-
40
-
<AccordionGroup>
41
-
<Accordiontitle="All of my OpenAPI pages are completely blank">
42
-
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document or your OpenAPI document is invalid.
43
-
44
-
Running `mint dev` locally should reveal some of these issues.
45
-
46
-
To verify your OpenAPI document will pass validation:
47
-
48
-
1. Run `mint openapi-check <openapiFilenameOrUrl>` in your CLI.
49
-
2. Validate your OpenAPI spec with [Swagger Editor](https://editor.swagger.io/).
50
-
51
-
Additionally, Mintlify does not support OpenAPI 2.0. If your document uses OpenAPI 2.0, you may encounter this issue. You can convert your document with [Swagger Editor](https://editor.swagger.io/).
52
-
53
-
<Frame>
54
-

55
-
</Frame>
56
-
</Accordion>
57
-
<Accordiontitle="One of my OpenAPI pages is completely blank">
58
-
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure that the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
59
-
60
-
Here's an example of how things might go wrong:
61
-
62
-
```md get-user.mdx
63
-
---
64
-
openapi: "GET /users/{id}/"
65
-
---
66
-
```
67
-
68
-
```yaml openapi.yaml
69
-
paths:
70
-
"/users/{id}":
71
-
get: ...
72
-
```
73
-
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
74
-
document does not.
75
-
76
-
Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document
77
-
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
78
-
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:
79
-
80
-
```md api-reference/v1/users/get-user.mdx
81
-
---
82
-
openapi: "v1 GET /users/{id}"
83
-
---
84
-
```
85
-
</Accordion>
86
-
<Accordion title="Requests from the API Playground don't work">
87
-
If you have a custom domain configured, this could be an issue with your reverse proxy. By
88
-
default, requests made via the API Playground start with a `POST` request to the
89
-
`/api/request`path on the docs site. If your reverse proxy is configured to only allow `GET`
90
-
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
91
-
allow `POST` requests to the `/api/request` path.
92
-
93
-
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`. See the [configurations for the API playground](/settings#param-proxy) for more information. This will
94
-
likely require you to configure CORS on your server, as these requests will now come directly
0 commit comments