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
25 changes: 25 additions & 0 deletions es/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,31 @@ Si distintos endpoints de tu API requieren diferentes métodos de autenticación

Para obtener más información sobre cómo definir y aplicar la autenticación, consulta [Authentication](https://swagger.io/docs/specification/authentication/) en la documentación de OpenAPI.

<div id="set-default-values-for-security-schemes">
#### Establecer valores predeterminados para esquemas de seguridad
</div>

Usa la extensión `x-default` en un esquema de seguridad para rellenar previamente el campo de autenticación en el playground de la API. Esto es útil para proporcionar valores de ejemplo o credenciales de prueba que ayuden a los usuarios a comenzar rápidamente.

```json {6}
{
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"x-default": "your-api-key-here"
}
}
}
}
```

La extensión `x-default` es compatible con los tipos de esquema de seguridad `apiKey` y `http` bearer. El valor aparece como la entrada predeterminada en los campos de autenticación del playground.

También puedes usar `x-default` en cualquier propiedad de esquema en tu especificación de OpenAPI para establecer un valor predeterminado en el playground de la API sin afectar el campo `default` en la definición del esquema.

<div id="customize-your-endpoint-pages">
## Personaliza las páginas de tus endpoints
</div>
Expand Down
25 changes: 25 additions & 0 deletions fr/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,31 @@ Si différents endpoints de votre API nécessitent différentes méthodes d’au

Pour plus d’informations sur la définition et l’application de l’authentification, consultez la section [Authentication](https://swagger.io/docs/specification/authentication/) de la documentation OpenAPI.

<div id="set-default-values-for-security-schemes">
#### Définir des valeurs par défaut pour les schémas de sécurité
</div>

Utilisez l’extension `x-default` sur un schéma de sécurité pour pré-remplir le champ d’authentification dans le playground de l’API. Cela est utile pour fournir des valeurs d’exemple ou des identifiants de test qui aident les utilisateurs à démarrer rapidement.

```json {6}
{
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"x-default": "your-api-key-here"
}
}
}
}
```

L’extension `x-default` est prise en charge pour les types de schéma de sécurité `apiKey` et `http` bearer. La valeur apparaît comme entrée par défaut dans les champs d’authentification du playground.

Vous pouvez également utiliser `x-default` sur n’importe quelle propriété de schéma dans votre spécification OpenAPI pour définir une valeur par défaut dans le playground de l’API sans affecter le champ `default` dans la définition du schéma.

<div id="customize-your-endpoint-pages">
## Personnalisez les pages de vos endpoints
</div>
Expand Down
25 changes: 25 additions & 0 deletions zh/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,31 @@ API playground 会使用这些服务器 URL 来确定请求的发送目标。如

有关定义和应用身份验证的更多信息,请参阅 OpenAPI 文档中的[Authentication](https://swagger.io/docs/specification/authentication/)。

<div id="set-default-values-for-security-schemes">
#### 为安全方案设置默认值
</div>

在安全方案上使用 `x-default` 扩展,可以在 API playground 中预填身份验证字段。这对于提供占位值或测试凭据非常有用,能帮助用户快速上手。

```json {6}
{
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"x-default": "your-api-key-here"
}
}
}
}
```

`x-default` 扩展支持 `apiKey` 和 `http` bearer 安全方案类型。该值会作为 playground 身份验证字段中的默认输入显示。

你还可以在 OpenAPI 规范中的任何 schema 属性上使用 `x-default`,以在 API playground 中设置默认值,而不影响 schema 定义中的 `default` 字段。

<div id="customize-your-endpoint-pages">
## 自定义端点页面
</div>
Expand Down
Loading