diff --git a/es/api-playground/overview.mdx b/es/api-playground/overview.mdx index 3fa0c2b83..2aefe360a 100644 --- a/es/api-playground/overview.mdx +++ b/es/api-playground/overview.mdx @@ -74,33 +74,33 @@ Recomendamos generar tu área de pruebas de la API a partir de una especificaci
- ## Personalización del área de pruebas + ## Personaliza tu área de pruebas
Puedes personalizar tu área de pruebas de la API definiendo las siguientes propiedades en tu `docs.json`. - Configuraciones del área de pruebas de la API. + Configuración del área de pruebas de la API. - El modo de visualización del área de pruebas de la API. + Modo de visualización del área de pruebas de la API. * `"interactive"`: Muestra el área de pruebas interactiva. - * `"simple"`: Muestra un endpoint que se puede copiar, sin área de pruebas. + * `"simple"`: Muestra un endpoint copiable sin área de pruebas. * `"none"`: No muestra nada. El valor predeterminado es `interactive`. - Indica si se deben enviar las solicitudes de la API a través de un servidor proxy. De manera predeterminada es `true`. + Indica si se deben pasar las solicitudes de la API a través de un servidor proxy. De manera predeterminada es `true`. - Configuraciones para los ejemplos de API generados automáticamente. + Configuración de los ejemplos de API generados automáticamente. @@ -112,6 +112,10 @@ Puedes personalizar tu área de pruebas de la API definiendo las siguientes prop Indica si se deben mostrar los parámetros opcionales en los ejemplos de la API. De manera predeterminada es `all`. + + + Indica si se debe rellenar previamente el área de pruebas de la API con datos de ejemplos del esquema. Cuando está activado, el área de pruebas completa automáticamente los campos de la solicitud con valores de ejemplo de tu especificación de OpenAPI. De manera predeterminada es `false`. + @@ -127,13 +131,14 @@ Puedes personalizar tu área de pruebas de la API definiendo las siguientes prop }, "examples": { "languages": ["curl", "python", "javascript"], - "defaults": "required" + "defaults": "required", + "prefill": true } } } ``` -Este ejemplo configura el área de pruebas de la API para que sea interactiva, con fragmentos de código de ejemplo para cURL, Python y JavaScript. Solo se muestran los parámetros obligatorios en los fragmentos de código. +Este ejemplo configura el área de pruebas de la API para que sea interactiva, con fragmentos de código de ejemplo para cURL, Python y JavaScript. En los fragmentos de código solo se muestran los parámetros obligatorios, y el área de pruebas rellena previamente el cuerpo de la solicitud con valores de ejemplo.
### Páginas de endpoints personalizadas diff --git a/es/organize/settings.mdx b/es/organize/settings.mdx index 5d95d3b95..00fb5972b 100644 --- a/es/organize/settings.mdx +++ b/es/organize/settings.mdx @@ -679,7 +679,7 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Directorio en el que buscar archivos OpenAPI. + Directorio donde buscar archivos OpenAPI. No incluyas una barra inicial. @@ -697,7 +697,7 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Directorio en el que buscar archivos AsyncAPI. + Directorio donde buscar archivos AsyncAPI. No incluyas una barra inicial. @@ -723,7 +723,7 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Indica si las solicitudes de la API se envían a través de un servidor proxy. El valor predeterminado es `true`. + Indica si las solicitudes de la API pasan por un servidor proxy. El valor predeterminado es `true`. @@ -733,17 +733,21 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Idiomas de ejemplo para los fragmentos de API generados automáticamente + Lenguajes de ejemplo para los fragmentos de API generados automáticamente Indica si se muestran los parámetros opcionales en los ejemplos de la API. El valor predeterminado es `all`. + + + Indica si se precarga el área de pruebas de la API con datos de ejemplos de esquemas. Cuando está habilitado, el área de pruebas completa automáticamente los campos de la solicitud con valores de ejemplo de tu especificación OpenAPI. El valor predeterminado es `false`. + - Configuración de las páginas de la API generadas a partir de archivos `MDX`. + Configuración para páginas de API generadas a partir de archivos `MDX`. @@ -751,17 +755,17 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Método de autenticación para solicitudes de la API. + Método de autenticación para solicitudes de API. - Nombre de la autenticación para solicitudes de la API. + Nombre de la autenticación para solicitudes de API. - Configuración del servidor para solicitudes de la API. + Configuración del servidor para solicitudes de API. diff --git a/fr/api-playground/overview.mdx b/fr/api-playground/overview.mdx index 0adf7a5bc..1e94052d1 100644 --- a/fr/api-playground/overview.mdx +++ b/fr/api-playground/overview.mdx @@ -74,7 +74,7 @@ Nous recommandons de générer votre bac à sable d’API à partir d’une spé
- ## Personnaliser votre bac à sable + ## Personnalisation de votre bac à sable
Vous pouvez personnaliser votre bac à sable d’API en définissant les propriétés suivantes dans votre `docs.json`. @@ -86,32 +86,36 @@ Vous pouvez personnaliser votre bac à sable d’API en définissant les propri Le mode d’affichage du bac à sable d’API. - * `"interactive"` : afficher le bac à sable interactif. - * `"simple"` : afficher un point de terminaison copiable sans bac à sable. - * `"none"` : ne rien afficher. + * `"interactive"` : affiche le bac à sable interactif. + * `"simple"` : affiche un endpoint copiable sans bac à sable. + * `"none"` : n’affiche rien. Valeur par défaut : `interactive`. - Indique s’il faut faire transiter les requêtes d’API par un serveur proxy. Valeur par défaut : `true`. + Indique s’il faut faire transiter les requêtes d’API via un serveur proxy. Valeur par défaut : `true`. - Paramètres de configuration pour les exemples d’API générés automatiquement. + Paramètres de configuration des exemples d’API générés automatiquement. - Langages pour les extraits d’API générés automatiquement. + Langues d’exemples pour les extraits d’API générés automatiquement. - Les langages s’affichent dans l’ordre spécifié. + Les langues s’affichent dans l’ordre spécifié. Indique s’il faut afficher les paramètres optionnels dans les exemples d’API. Valeur par défaut : `all`. + + + Indique s’il faut préremplir le bac à sable d’API avec les données issues des exemples de schéma. Lorsque cette option est activée, le bac à sable renseigne automatiquement les champs de requête avec des valeurs d’exemple provenant de votre spécification OpenAPI. Valeur par défaut : `false`. + @@ -127,13 +131,14 @@ Vous pouvez personnaliser votre bac à sable d’API en définissant les propri }, "examples": { "languages": ["curl", "python", "javascript"], - "defaults": "required" + "defaults": "required", + "prefill": true } } } ``` -Cet exemple configure le bac à sable d’API pour qu’il soit interactif, avec des extraits de code pour cURL, Python et JavaScript. Seuls les paramètres requis sont affichés dans les extraits de code. +Cet exemple configure le bac à sable d’API pour qu’il soit interactif, avec des extraits de code pour cURL, Python et JavaScript. Seuls les paramètres obligatoires sont affichés dans les extraits, et le bac à sable préremplit le corps de la requête avec des valeurs d’exemple.
### Pages d’endpoint personnalisées diff --git a/fr/organize/settings.mdx b/fr/organize/settings.mdx index 662ef7ebe..f96cbb037 100644 --- a/fr/organize/settings.mdx +++ b/fr/organize/settings.mdx @@ -661,7 +661,7 @@ Cette section présente la référence complète du fichier `docs.json`.
- ### Paramétrages d’API + ### Configuration d’API
@@ -675,7 +675,7 @@ Cette section présente la référence complète du fichier `docs.json`. URL ou chemin vers votre fichier de spécification OpenAPI. - Longueur minimale : 1 + Longueur minimale : 1 @@ -693,7 +693,7 @@ Cette section présente la référence complète du fichier `docs.json`. URL ou chemin vers votre fichier de spécification AsyncAPI. - Longueur minimale : 1 + Longueur minimale : 1 @@ -709,7 +709,7 @@ Cette section présente la référence complète du fichier `docs.json`. - Indique s’il faut développer tous les paramètres par défaut. Par défaut : `closed`. + Indique s’il faut développer tous les paramètres par défaut. Valeur par défaut : `closed`. @@ -719,17 +719,17 @@ Cette section présente la référence complète du fichier `docs.json`. - Mode d’affichage du bac à sable d’API. Par défaut : `interactive`. + Mode d’affichage du bac à sable d’API. Valeur par défaut : `interactive`. - Indique s’il faut faire transiter les requêtes d’API via un serveur proxy. Par défaut : `true`. + Indique si les requêtes d’API doivent passer par un serveur proxy. Valeur par défaut : `true`. - Paramètres pour les exemples d’API générés automatiquement. + Configuration des exemples d’API générés automatiquement. @@ -737,13 +737,17 @@ Cette section présente la référence complète du fichier `docs.json`. - Indique s’il faut afficher les paramètres optionnels dans les exemples d’API. Par défaut : `all`. + Indique s’il faut afficher les paramètres optionnels dans les exemples d’API. Valeur par défaut : `all`. + + + + Indique s’il faut préremplir le bac à sable d’API avec des données issues des exemples de schéma. Lorsqu’elle est activée, l’interface remplit automatiquement les champs de requête avec des valeurs d’exemple tirées de votre spécification OpenAPI. Valeur par défaut : `false`. - Paramètres pour les pages d’API générées à partir de fichiers `MDX`. + Configuration des pages d’API générées à partir de fichiers `MDX`. @@ -755,7 +759,7 @@ Cette section présente la référence complète du fichier `docs.json`. - Nom d’authentification pour les requêtes d’API. + Nom de l’authentification pour les requêtes d’API. diff --git a/zh/api-playground/overview.mdx b/zh/api-playground/overview.mdx index 4368c9df1..4da06162b 100644 --- a/zh/api-playground/overview.mdx +++ b/zh/api-playground/overview.mdx @@ -74,7 +74,7 @@ API 操作台是一个交互式环境，便于用户测试并探索你的 API
- ## 自定义你的操作台 + ## 自定义操作台
你可以在 `docs.json` 中通过定义以下属性来自定义 API 操作台。 @@ -100,11 +100,11 @@ API 操作台是一个交互式环境，便于用户测试并探索你的 API - 自动生成的 API 示例的相关配置。 + 自动生成的 API 示例配置。 - 自动生成的 API 代码片段所使用的示例语言。 + 自动生成的 API 代码片段的示例语言。 语言按指定顺序显示。 @@ -112,6 +112,10 @@ API 操作台是一个交互式环境，便于用户测试并探索你的 API 是否在 API 示例中显示可选参数。默认为 `all`。 + + + 是否使用架构示例的数据预填充 API 操作台。启用后，操作台会自动使用你的 OpenAPI 规范中的示例值填充请求字段。默认为 `false`。 + @@ -127,13 +131,14 @@ API 操作台是一个交互式环境，便于用户测试并探索你的 API }, "examples": { "languages": ["curl", "python", "javascript"], - "defaults": "required" + "defaults": "required", + "prefill": true } } } ``` -此示例将 API 操作台配置为可交互，并提供 cURL、Python 和 JavaScript 的示例代码片段。代码片段中仅展示必填参数。 +此示例将 API 操作台配置为可交互，并提供 cURL、Python 和 JavaScript 的示例代码片段。代码片段仅显示必填参数，且操作台会用示例值预填请求正文。
### 自定义端点页面 diff --git a/zh/organize/settings.mdx b/zh/organize/settings.mdx index 21dbf5618..ff63a5424 100644 --- a/zh/organize/settings.mdx +++ b/zh/organize/settings.mdx @@ -665,11 +665,11 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
- API 文档与交互式操作台设置。 + API 文档与交互式操作台的设置。 - 用于生成 API 文档的 OpenAPI 规范文件。可以是单个 URL/路径，或一个由多个 URL/路径组成的数组。 + 用于生成 API 文档的 OpenAPI 规范文件。可以是单个 URL/路径，或由多个 URL/路径组成的数组。 @@ -679,15 +679,15 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; - 用于搜索 OpenAPI 文件的目录。 + 搜索 OpenAPI 文件的目录。 - 开头请勿包含斜杠。 + 请勿包含前导斜杠。 - 用于生成 API 文档的 AsyncAPI 规范文件。可以是单个 URL/路径，或一个由多个 URL/路径组成的数组。 + 用于生成 API 文档的 AsyncAPI 规范文件。可以是单个 URL/路径，或由多个 URL/路径组成的数组。 @@ -697,9 +697,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; - 用于搜索 AsyncAPI 文件的目录。 + 搜索 AsyncAPI 文件的目录。 - 开头请勿包含斜杠。 + 请勿包含前导斜杠。 @@ -733,21 +733,25 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; - 自动生成的 API 代码片段所使用的示例语言 + 自动生成 API 代码片段的示例语言。 是否在 API 示例中显示可选参数。默认值为 `all`。 + + + 是否使用架构示例数据预填充 API 操作台。启用后，操作台会根据 OpenAPI 规范中的示例值自动填充请求字段。默认值为 `false`。 + - 由 `MDX` 文件生成的 API 页面配置。 + 基于 `MDX` 文件生成的 API 页面配置。 - 基于 MDX 的 API 请求认证配置。 + 基于 MDX 的 API 请求的认证配置。