diff --git a/es/api-playground/troubleshooting.mdx b/es/api-playground/troubleshooting.mdx index 996c00700..0a96994cd 100644 --- a/es/api-playground/troubleshooting.mdx +++ b/es/api-playground/troubleshooting.mdx @@ -34,13 +34,18 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d Esto suele deberse a un campo `openapi` mal escrito en la metadata de la página. Asegúrate de que - el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta del documento de OpenAPI. + el método HTTP y la ruta coincidan con el método HTTP y la ruta del documento de OpenAPI. + + + Mintlify resuelve automáticamente las diferencias de barra final entre tu referencia `openapi` + y la especificación de OpenAPI. Por ejemplo, `GET /users/{id}/` coincide con una ruta de la especificación `/users/{id}`. + Aquí tienes un ejemplo de cómo puede salir mal: ```mdx get-user.mdx --- - openapi: "GET /users/{id}/" + openapi: "GET /user/{id}" --- ``` @@ -50,7 +55,7 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d get: ... ``` - Observa que la ruta en el campo `openapi` tiene una barra al final, mientras que la ruta en el documento de OpenAPI no la tiene. + Observa que la ruta en el campo `openapi` dice `/user/{id}` (singular), mientras que la ruta en el documento de OpenAPI es `/users/{id}` (plural). Otro problema común es un nombre de archivo mal escrito. Si especificas un documento de OpenAPI en particular en el campo `openapi`, asegúrate de que el nombre del archivo sea correcto. Por ejemplo, si tienes dos documentos de OpenAPI `openapi/v1.json` y `openapi/v2.json`, tu metadata podría verse así: diff --git a/fr/api-playground/troubleshooting.mdx b/fr/api-playground/troubleshooting.mdx index f75cbedd8..357580086 100644 --- a/fr/api-playground/troubleshooting.mdx +++ b/fr/api-playground/troubleshooting.mdx @@ -33,13 +33,18 @@ Si vos pages API ne s’affichent pas correctement, consultez ces problèmes de - Ceci est généralement dû à une faute d’orthographe du champ `openapi` dans la metadata de la page. Assurez-vous que la méthode HTTP et le chemin correspondent exactement à la méthode HTTP et au chemin dans le document OpenAPI. + Ceci est généralement dû à une faute d’orthographe du champ `openapi` dans la metadata de la page. Assurez-vous que la méthode HTTP et le chemin correspondent à la méthode HTTP et au chemin dans le document OpenAPI. - Voici un exemple de la façon dont cela peut mal tourner : + + Mintlify résout automatiquement les différences de barre oblique finale entre votre référence `openapi` + et la spécification OpenAPI. Par exemple, `GET /users/{id}/` correspond à un chemin de spécification `/users/{id}`. + + + Voici un exemple de la façon dont cela peut mal tourner : ```mdx get-user.mdx --- - openapi: "GET /users/{id}/" + openapi: "GET /user/{id}" --- ``` @@ -49,7 +54,7 @@ Si vos pages API ne s’affichent pas correctement, consultez ces problèmes de get: ... ``` - Notez que le chemin dans le champ `openapi` se termine par une barre oblique, alors que le chemin dans le document OpenAPI n’en a pas. + Notez que le chemin dans le champ `openapi` indique `/user/{id}` (au singulier), alors que le chemin dans le document OpenAPI est `/users/{id}` (au pluriel). Un autre problème fréquent est une erreur dans le nom de fichier. Si vous indiquez un document OpenAPI précis dans le champ `openapi`, assurez-vous que le nom de fichier est correct. Par exemple, si vous avez deux documents OpenAPI `openapi/v1.json` et `openapi/v2.json`, vos metadata pourraient ressembler à ceci : diff --git a/zh/api-playground/troubleshooting.mdx b/zh/api-playground/troubleshooting.mdx index d3dfbaf51..35cabfb5f 100644 --- a/zh/api-playground/troubleshooting.mdx +++ b/zh/api-playground/troubleshooting.mdx @@ -31,13 +31,18 @@ keywords: ["API 故障排查", "OpenAPI 无效", "配置问题"] 这通常是由于页面 metadata 中的 `openapi` 字段拼写错误导致的。请确保 - HTTP 方法和路径与 OpenAPI 文档中的 HTTP 方法和路径完全一致。 + HTTP 方法和路径与 OpenAPI 文档中的 HTTP 方法和路径一致。 + + + Mintlify 会自动解析 `openapi` 引用与 OpenAPI 规范之间尾部斜杠的差异。 + 例如,`GET /users/{id}/` 可以匹配规范中的路径 `/users/{id}`。 + 下面是一个可能出错的示例: ```mdx get-user.mdx --- - openapi: "GET /users/{id}/" + openapi: "GET /user/{id}" --- ``` @@ -47,7 +52,7 @@ keywords: ["API 故障排查", "OpenAPI 无效", "配置问题"] get: ... ``` - 请注意,`openapi` 字段中的路径以斜杠结尾,而 OpenAPI 文档中的路径没有。 + 请注意,`openapi` 字段中的路径是 `/user/{id}` (单数),而 OpenAPI 文档中的路径是 `/users/{id}` (复数)。 另一个常见问题是文件名拼写错误。如果你在 `openapi` 字段中指定了某个特定的 OpenAPI 文档,请确保文件名正确。例如,如果你有两个 OpenAPI 文档 `openapi/v1.json` 和 `openapi/v2.json`,你的 metadata 可能如下所示: