Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions es/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,20 @@ Recomendamos la extensión `x-mint` para que toda la documentación de tu API se

Recomendamos las páginas MDX individuales para APIs pequeñas o cuando quieras experimentar con cambios página por página.

<div id="edit-request-bodies-as-json">
## Editar cuerpos de solicitud como JSON
</div>

Cuando un endpoint acepta un cuerpo de solicitud JSON (`application/json` o un tipo de medio `+json`), la sección del cuerpo del playground muestra un selector **Form** y **JSON**. Usa **Form** para completar un campo a la vez. Usa **JSON** para editar todo el cuerpo en un editor de código, por ejemplo, para pegar una respuesta de otro endpoint y cambiar algunos valores antes de enviarla.

- Form y JSON editan el mismo cuerpo, por lo que los cambios en una vista aparecen en la otra. La solicitud que envías y los ejemplos de código generados siempre coinciden con el cuerpo.
- JSON conserva las propiedades que no están en tu esquema OpenAPI y las envía con la solicitud.
- Si el JSON no es válido, el playground muestra la línea, la columna y la causa probable del primer error después de que sales de la línea que estás editando. No puedes enviar la solicitud hasta que el JSON sea válido. Si cambias a **Form**, el playground te pide confirmación antes de reemplazar el JSON no válido por el cuerpo predeterminado.
- Pasa el cursor sobre el editor para copiar el JSON o restablecer el cuerpo a su valor predeterminado.
- El playground recuerda la vista que elegiste y la usa para otros endpoints.

El selector no aparece para otros tipos de cuerpo de solicitud, como `multipart/form-data` o `application/x-www-form-urlencoded`.

<div id="response-rendering">
## Renderizado de respuestas
</div>
Expand Down
14 changes: 14 additions & 0 deletions fr/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,20 @@ Nous recommandons l’extension `x-mint` afin que toute votre documentation d’

Nous recommandons les pages MDX individuelles pour les petites API ou lorsque vous souhaitez expérimenter des modifications page par page.

<div id="edit-request-bodies-as-json">
## Modifier les corps de requête en JSON
</div>

Lorsqu’un endpoint accepte un corps de requête JSON (`application/json` ou un type de média `+json`), la section du corps du playground affiche un sélecteur **Form** et **JSON**. Utilisez **Form** pour remplir un champ à la fois. Utilisez **JSON** pour modifier l’ensemble du corps dans un éditeur de code, par exemple pour coller une réponse provenant d’un autre endpoint et modifier quelques valeurs avant de l’envoyer.

- Form et JSON modifient le même corps : les changements effectués dans une vue apparaissent dans l’autre. La requête que vous envoyez et les exemples de code générés correspondent toujours au corps.
- JSON conserve les propriétés qui ne figurent pas dans votre schéma OpenAPI et les envoie avec la requête.
- Si le JSON est invalide, le playground affiche la ligne, la colonne et la cause probable de la première erreur une fois que vous quittez la ligne en cours de modification. Vous ne pouvez pas envoyer la requête tant que le JSON n’est pas valide. Si vous passez à **Form**, le playground vous demande confirmation avant de remplacer le JSON invalide par le corps par défaut.
- Survolez l’éditeur pour copier le JSON ou réinitialiser le corps à sa valeur par défaut.
- Le playground mémorise la vue que vous avez choisie et l’utilise pour les autres endpoints.

Le sélecteur n’apparaît pas pour les autres types de corps de requête, comme `multipart/form-data` ou `application/x-www-form-urlencoded`.

<div id="response-rendering">
## Rendu des réponses
</div>
Expand Down
14 changes: 14 additions & 0 deletions zh/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,20 @@ public: true

对于小型 API,或者当你希望在单个页面上逐页试验更改时,我们推荐使用单独的 MDX 页面。

<div id="edit-request-bodies-as-json">
## 以 JSON 形式编辑请求体
</div>

当 endpoint 接受 JSON 请求体(`application/json` 或 `+json` 媒体类型)时,playground 的请求体部分会显示 **Form** 和 **JSON** 切换开关。使用 **Form** 逐个填写字段。使用 **JSON** 在代码编辑器中编辑整个请求体,例如粘贴来自另一个 endpoint 的响应,并在发送前修改其中几个值。

- Form 和 JSON 编辑的是同一个请求体,因此在一个视图中的更改会同步显示在另一个视图中。你发送的请求和生成的代码示例始终与请求体保持一致。
- JSON 会保留不在你的 OpenAPI 架构中的属性,并随请求一起发送。
- 如果 JSON 无效,在你离开正在编辑的行后,playground 会显示第一个错误的行号、列号及可能的原因。在 JSON 有效之前,你无法发送请求。如果你切换到 **Form**,playground 会在用默认请求体替换无效 JSON 之前请你确认。
- 将鼠标悬停在编辑器上,可以复制 JSON 或将请求体重置为默认值。
- playground 会记住你选择的视图,并在其他 endpoint 中沿用。

对于其他请求体类型(例如 `multipart/form-data` 或 `application/x-www-form-urlencoded`),不会显示该切换开关。

<div id="response-rendering">
## 响应渲染
</div>
Expand Down
Loading