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
Copy file name to clipboardExpand all lines: es/api-playground/mdx-setup.mdx
+89-21Lines changed: 89 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
title: "Crear páginas de API manualmente"
3
-
description: "Documenta endpoints de API manualmente con archivos MDX."
2
+
title: "Crear páginas de API manuales"
3
+
description: "Documenta endpoints de la API manualmente con archivos MDX."
4
4
keywords: ["Documentación de API", "Documentación de endpoints"]
5
5
---
6
6
7
-
Puedes definir endpoints de API manualmente en páginas individuales. Este enfoque es útil para API pequeñas o para prototipos.
7
+
Puedes definir endpoints de API manualmente en páginas MDX individuales. Este enfoque es útil para APIs pequeñas o para crear prototipos.
8
8
9
9
<divid="setup">
10
10
## Configuración
11
11
</div>
12
12
13
13
<Steps>
14
-
<Steptitle="Configura la API">
15
-
En tu archivo `docs.json`, define la URL base y el método de autenticación.
14
+
<Steptitle="Configura la configuración de la API">
15
+
En tu archivo `docs.json`, configura tu URL base y el método de autenticación.
16
16
17
17
```json
18
18
"api": {
@@ -26,7 +26,7 @@ Puedes definir endpoints de API manualmente en páginas individuales. Este enfoq
26
26
}
27
27
```
28
28
29
-
Si quieres ocultar el playground de la API, establece el campo `display`en`none`. No necesitas incluir un método de autenticación si ocultas el playground.
29
+
Si quieres ocultar el área de pruebas de la API, configura el campo `display`como`none`. No necesitas incluir ningún método de autenticación si ocultas el área de pruebas de la API.
30
30
31
31
```json
32
32
"api": {
@@ -39,45 +39,45 @@ Puedes definir endpoints de API manualmente en páginas individuales. Este enfoq
39
39
Consulta la lista completa de configuraciones de la API en [Settings](/es/organize/settings#api-configurations).
40
40
</Step>
41
41
42
-
<Steptitle="Crea las páginas de endpoints">
43
-
Crea un archivo `MDX` para cada endpoint. Define `title` y `api` en el frontmatter:
42
+
<Steptitle="Crea las páginas de tus endpoints">
43
+
Crea un archivo MDX para cada endpoint. Define `title` y `api` en el frontmatter:
44
44
45
45
```mdx
46
46
---
47
-
title: 'Create new user'
47
+
title: 'Crear nuevo usuario'
48
48
api: 'POST https://api.mintlify.com/user'
49
49
---
50
50
```
51
51
52
-
Especifica los parámetros de ruta envolviéndolos entre `{}`:
52
+
Especifica los parámetros de ruta colocándolos entre `{}`:
53
53
54
54
```bash
55
55
https://api.example.com/v1/endpoint/{userId}
56
56
```
57
57
58
58
<Tip>
59
-
Si tienes un campo `server` configurado en `docs.json`, puedes usar rutas relativas como `/v1/endpoint`.
59
+
Si tienes configurado un campo `server` en `docs.json`, puedes usar rutas relativas como `/v1/endpoint`.
60
60
</Tip>
61
61
62
-
Para anular el modo de visualización global del playground en una página específica, agrega`playground` al frontmatter:
62
+
Para anular el modo de visualización global del playground en una página específica, añade`playground` al frontmatter:
63
63
64
64
```mdx
65
65
---
66
-
title: 'Create new user'
66
+
title: 'Crear nuevo usuario'
67
67
api: 'POST https://api.mintlify.com/user'
68
68
playground: 'none'
69
69
---
70
70
```
71
71
72
-
Opciones:
72
+
Options:
73
73
74
-
*`playground: 'interactive'` - Muestra el playground interactivo (predeterminado)
75
-
*`playground: 'simple'` - Muestra un endpoint copiable sin playground
76
-
*`playground: 'none'` - Oculta el playground por completo
74
+
*`playground: 'interactive'` - Mostrar el playground interactivo (predeterminado)
75
+
*`playground: 'simple'` - Mostrar un endpoint copiable sin playground
76
+
*`playground: 'none'` - Ocultar el playground por completo
77
77
</Step>
78
78
79
-
<Steptitle="Agrega parámetros y respuestas">
80
-
Usa los [campos de parámetros y respuestas](/es/components/fields) para documentar los parámetros y valores de retorno de tu endpoint.
79
+
<Steptitle="Añadir parámetros y respuestas">
80
+
Utiliza los [campos de parámetros y de respuesta](/es/components/fields) para documentar los parámetros y los valores de retorno de tu endpoint.
81
81
82
82
```mdx
83
83
<ParamFieldpath="userId"type="string"required>
@@ -98,8 +98,76 @@ Puedes definir endpoints de API manualmente en páginas individuales. Este enfoq
98
98
```
99
99
</Step>
100
100
101
-
<Steptitle="Agrega los endpoints a tu documentación">
102
-
Agrega las páginas de endpoints a la navegación actualizando el campo `pages` en tu `docs.json`. Obtén más información sobre cómo estructurar tu documentación en [Navigation](/es/organize/navigation).
101
+
<Steptitle="Incorpora tus endpoints a tu documentación">
102
+
Agrega las páginas de tus endpoints a la navegación actualizando el campo `pages` en tu `docs.json`:
103
+
104
+
```json docs.json
105
+
"navigation": {
106
+
"tabs": [
107
+
{
108
+
"tab": "Referencia de la API",
109
+
"groups": [
110
+
{
111
+
"group": "Usuarios",
112
+
"pages": [
113
+
"api-reference/users/create-user",
114
+
"api-reference/users/get-user",
115
+
"api-reference/users/update-user"
116
+
]
117
+
},
118
+
{
119
+
"group": "Pedidos",
120
+
"pages": [
121
+
"api-reference/orders/create-order",
122
+
"api-reference/orders/list-orders"
123
+
]
124
+
}
125
+
]
126
+
}
127
+
]
128
+
}
129
+
```
130
+
131
+
Cada ruta de página corresponde a un archivo MDX en tu repositorio de documentación. Por ejemplo, `api-reference/users/create-user.mdx`. Consulta más detalles sobre cómo estructurar tu documentación en [Navigation](/es/organize/navigation).
132
+
133
+
### Usar endpoints de OpenAPI en navigation
134
+
135
+
Si tienes una especificación de OpenAPI, puedes hacer referencia a endpoints directamente en tu navigation sin crear archivos MDX individuales. Haz referencia a endpoints específicos incluyendo la ruta del archivo de OpenAPI y el endpoint:
136
+
137
+
```json docs.json
138
+
"navigation": {
139
+
"pages": [
140
+
"introducción",
141
+
"/path/to/users-openapi.json POST /users",
142
+
"/path/to/orders-openapi.json GET /orders"
143
+
]
144
+
}
145
+
```
146
+
147
+
También puedes definir una especificación de OpenAPI predeterminada para un grupo de navigation y hacer referencia a los endpoints por método y ruta:
148
+
149
+
```json docs.json
150
+
{
151
+
"group": "Referencia de API",
152
+
"openapi": "/path/to/openapi-v1.json",
153
+
"pages": [
154
+
"descripción-general",
155
+
"autenticación",
156
+
"GET /users",
157
+
"POST /users",
158
+
{
159
+
"group": "Pedidos",
160
+
"openapi": "/path/to/openapi-v2.json",
161
+
"pages": [
162
+
"GET /orders",
163
+
"POST /orders"
164
+
]
165
+
}
166
+
]
167
+
}
168
+
```
169
+
170
+
Para más información sobre la integración de OpenAPI, consulta [configuración de OpenAPI](/es/api-playground/openapi-setup).
Copy file name to clipboardExpand all lines: es/api-playground/overview.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,17 +149,17 @@ Este ejemplo configura el área de pruebas de la API para que sea interactiva, c
149
149
### Páginas de endpoints personalizadas
150
150
</div>
151
151
152
-
Cuando necesites más control sobre la documentación de tu API, usa la extensión `x-mint` en tu especificación de OpenAPI o crea páginas `MDX` individuales para tus endpoints.
152
+
Cuando necesites más control sobre la documentación de tu API, usa la extensión `x-mint` en tu especificación OpenAPI o crea páginas MDX individuales para tus endpoints.
153
153
154
154
Ambas opciones te permiten:
155
155
156
-
* Personalizar los metadatos de la página
156
+
* Personalizar el metadata de la página
157
157
* Agregar contenido adicional, como ejemplos
158
158
* Controlar el comportamiento del playground por página
159
159
160
-
Se recomienda la extensión `x-mint` para que toda la documentación de tu API se genere automáticamente a partir de tu especificación de OpenAPI y se mantenga en un solo archivo.
160
+
Se recomienda la extensión `x-mint` para que toda la documentación de tu API se genere automáticamente a partir de tu especificación OpenAPI y se mantenga en un solo archivo.
161
161
162
-
Se recomiendan las páginas `MDX` individuales para APIs pequeñas o cuando quieras probar cambios por página.
162
+
Las páginas MDX individuales se recomiendan para APIs pequeñas o cuando quieras experimentar con cambios página por página.
Copy file name to clipboardExpand all lines: es/customize/react-components.mdx
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,11 @@ import { ColorGenerator } from "/snippets/color-generator.jsx";
8
8
9
9
Los [componentes de React](https://react.dev) son una forma eficaz de crear elementos interactivos y reutilizables en tu documentación.
10
10
11
-
12
11
<divid="using-react-components">
13
12
## Uso de componentes de React
14
13
</div>
15
14
16
-
Puedes construir componentes de React directamente en tus archivos `MDX` con [React hooks](https://react.dev/reference/react/hooks).
15
+
Puedes crear componentes de React directamente en tus archivos MDX mediante [hooks de React](https://react.dev/reference/react/hooks).
17
16
18
17
<divid="example">
19
18
### Ejemplo
@@ -99,15 +98,13 @@ El contador se representa como un componente interactivo de React.
99
98
## Importar componentes
100
99
</div>
101
100
102
-
Para importar componentes de React en tus archivos `MDX`, los archivos de los componentes deben estar en la carpeta `snippets`. Luego puedes importarlos en cualquier página `MDX` de tu documentación. Más información en [fragmentos reutilizables](/es/create/reusable-snippets).
101
+
Para importar componentes de React en tus archivos MDX, los archivos de los componentes deben estar ubicados en la carpeta `snippets`. Luego puedes importarlos en cualquier página MDX de tu documentación. Más información sobre [snippets reutilizables](/es/create/reusable-snippets).
103
102
104
-
<divid="example">
105
-
### Ejemplo
106
-
</div>
103
+
### Ejemplo
107
104
108
-
Este ejemplo declara un componente `ColorGenerator` que utiliza varios hooks de React y luego lo emplea en un archivo `MDX`.
105
+
Este ejemplo declara un componente `ColorGenerator` que usa varios hooks de React y luego lo utiliza en un archivo MDX.
109
106
110
-
Crea el archivo `color-generator.jsx` en la carpeta `snippets`:
107
+
Crea un archivo llamado`color-generator.jsx` en la carpeta `snippets`:
Copy file name to clipboardExpand all lines: es/deploy/personalization-setup.mdx
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,10 +49,10 @@ groups: ["admin"]
49
49
50
50
51
51
<div id="user-data-format">
52
-
## Formato de datos del usuario
52
+
## Formato de datos de usuario
53
53
</div>
54
54
55
-
Al implementar la personalización, tu sistema devuelve los datos del usuario en un formato específico que permite la personalización del contenido. Estos datos pueden enviarse como un objeto JSON sin procesar o dentro de un JWT (JSON Web Token) firmado, según el método de autenticación que utilices. La estructura de los datos es la misma en ambos casos.
55
+
Al implementar la personalización, tu sistema devuelve los datos de usuario en un formato específico que permite la personalización del contenido. Estos datos se pueden enviar como un objeto JSON bruto o dentro de un JWT firmado, según tu método de handshake. La estructura de los datos es la misma en ambos casos.
56
56
57
57
```tsx
58
58
type User = {
@@ -69,8 +69,8 @@ type User = {
69
69
```
70
70
71
71
<ParamField path="expiresAt" type="number">
72
-
Tiempo de expiración de la sesión en **segundos desde el epoch**. Si el usuario carga una página después de este momento, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse.
73
-
<Warning><b>Para intercambios con JWT:</b> Esto difiere del atributo`exp` del JWT, que determina cuándo se considera inválido un JWT. Por seguridad, establece el `exp` del JWT en una duración corta (10 segundos o menos). Usa `expiresAt` para la duración real de la sesión (de horas a semanas).</Warning>
72
+
Tiempo de expiración de la sesión en **segundos desde la época Unix**. Si el usuario carga una página después de este tiempo, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse.
73
+
<Warning><b>Para intercambios con JWT:</b> Esto es distinto del claim`exp` del JWT, que determina cuándo un JWT se considera inválido. Por seguridad, configura el claim `exp` del JWT con una duración corta (10 segundos o menos). Usa `expiresAt` para la duración real de la sesión (de horas a semanas).</Warning>
74
74
</ParamField>
75
75
76
76
<ParamField path="groups" type="string[]">
@@ -80,26 +80,26 @@ type User = {
80
80
</ParamField>
81
81
82
82
<ParamField path="content" type="object">
83
-
Datos personalizados accesibles en tu contenido `MDX` mediante la variable `user`. Úsalos para personalizar dinámicamente tu documentación.
83
+
Datos personalizados accesibles en tu contenido MDX a través de la variable `user`. Úsalos para realizar personalización dinámica en toda tu documentación.
Welcome back, {user.firstName}! Your {user.plan} plan includes...
95
95
```
96
96
97
-
Con los datos de `user` del ejemplo, se mostraría como: Welcome back, Ronan! Your Enterprise plan includes...
97
+
Con el ejemplo de datos de `user`, esto se renderizaría como: Welcome back, Ronan! Your Enterprise plan includes...
98
98
99
99
**Renderizado condicional avanzado**:
100
100
101
101
```jsx
102
-
La autenticación es una función de Enterprise. {
102
+
Authentication is an enterprise feature. {
103
103
user.org===undefined
104
104
?<>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
105
105
:user.org.plan!=='enterprise'
@@ -109,12 +109,12 @@ type User = {
109
109
```
110
110
111
111
<Note>
112
-
La información en `user` solo está disponible para usuarios con sesión iniciada. Para los usuarios que no han iniciado sesión, el valor de `user` será `{}`. Para evitar que la página falle con usuarios desconectados, usa siempre el encadenamiento opcional en los campos de `user`. Por ejemplo, `{user.org?.plan}`.
112
+
La información en `user` solo está disponible para usuarios con sesión iniciada. Para usuarios sin iniciar sesión, el valor de `user` será `{}`. Para evitar que la página falle para usuarios sin iniciar sesión, usa siempre encadenamiento opcional en los campos de `user`. Por ejemplo, `{user.org?.plan}`.
Valores específicos del usuario que rellenan por adelantado los campos del área de pruebas de la API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs.
117
+
Valores específicos del usuario que rellenan previamente los campos del área de pruebas de la API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs.
118
118
119
119
**Ejemplo**:
120
120
@@ -126,9 +126,9 @@ type User = {
126
126
}
127
127
```
128
128
129
-
Si un usuario realiza solicitudes en un subdomain específico, puedes enviar `{ server: { subdomain:'foo' } }` como un campo `apiPlaygroundInputs`. Este valor se rellenará por adelantado en cualquier página de la API con el valor `subdomain`.
129
+
Si un usuario realiza solicitudes en un subdominio específico, puedes enviar `{ server: { subdomain:'foo' } }` como un campo `apiPlaygroundInputs`. Este valor se rellenará previamente en cualquier página de la API con el valor `subdomain`.
130
130
131
-
<Note>Los campos `header`, `query` y `cookie` solo se rellenarán por adelantado si forman parte de tu [esquema de seguridad de OpenAPI](https://swagger.io/docs/specification/authentication/). Si un campo está en las secciones `Authorization` o `Server`, se rellenará por adelantado. Crear un parámetro de encabezado estándar llamado `Authorization` no habilitará esta función.</Note>
131
+
<Note>Los campos `header`, `query` y `cookie` solo se rellenarán previamente si forman parte de tu [esquema de seguridad de OpenAPI](https://swagger.io/docs/specification/authentication/). Si un campo está en las secciones `Authorization` o `Server`, se rellenará previamente. Crear un parámetro de encabezado estándar llamado `Authorization` no habilitará esta función.</Note>
Copy file name to clipboardExpand all lines: es/editor.mdx
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,15 +72,15 @@ El modo visual ofrece una experiencia WYSIWYG (what you see is what you get) en
72
72
</Frame>
73
73
74
74
<divid="markdown-mode">
75
-
### Modo Markdown
75
+
### Markdown mode
76
76
</div>
77
77
78
-
Modo Markdown proporciona acceso directo al código `MDX` subyacente de tu documentación. Este modo es ideal cuando necesitas un control preciso sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de Markdown.
78
+
Markdown mode ofrece acceso directo a los archivos que conforman tu documentación. Este modo es ideal cuando necesitas tener un control preciso sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de MDX.
79
79
80
80
<Frame>
81
-
<imgsrc="/images/editor/markdown-mode-light.png"alt="Modo Markdown en el editor visual de Mintlify"className="block dark:hidden" />
81
+
<imgsrc="/images/editor/markdown-mode-light.png"alt="Markdown mode en el editor visual de Mintlify"className="block dark:hidden" />
82
82
83
-
<imgsrc="/images/editor/markdown-mode-dark.png"alt="Modo Markdown en el editor visual de Mintlify"className="hidden dark:block" />
83
+
<imgsrc="/images/editor/markdown-mode-dark.png"alt="Markdown mode en el editor visual de Mintlify"className="hidden dark:block" />
84
84
</Frame>
85
85
86
86
<divid="manage-content">
@@ -179,23 +179,23 @@ En este ejemplo, creaste una nueva página titulada Temas y quieres agregarla al
179
179
### Editar contenido
180
180
</div>
181
181
182
-
Realiza cambios en tus páginas usando el modo visual o el Modo Markdown en el editor.
182
+
Realiza cambios en tus páginas usando el modo visual o Markdown mode en el editor.
183
183
184
-
En el modo visual, presiona <kbd>/</kbd> para abrir el menú de componentes. Agrega bloques de contenido, avisos, bloques de código y otros componentes para personalizar tu documentación.
184
+
En el modo visual, presiona <kbd>/</kbd> para abrir el menú de componentes. Agrega bloques de contenido, notas, bloques de código y otros componentes para personalizar tu documentación.
185
185
186
186
<Frame>
187
187
<imgsrc="/images/editor/component-menu-light.png"alt="El menú de componentes desplegado resaltado en el editor visual de Mintlify"className="block dark:hidden" />
188
188
189
189
<imgsrc="/images/editor/component-menu-dark.png"alt="El menú de componentes desplegado resaltado en el editor visual de Mintlify"className="hidden dark:block" />
190
190
</Frame>
191
191
192
-
En el Modo Markdown, editas directamente el `MDX` de tus páginas. Esto puede ser útil cuando necesitas:
192
+
En Markdown mode, puedes editar directamente el MDX de tus páginas. Esto puede ser útil cuando necesitas:
193
193
194
194
* Definir propiedades específicas de los componentes
195
195
* Trabajar con componentes anidados complejos
196
-
* Copiar y pegar contenido `MDX` de otras fuentes
196
+
* Copiar y pegar contenido MDX desde otras fuentes
197
197
198
-
Consulta [Formatear texto](/es/create/text) y [Formatear código](/es/create/code) para obtener más información sobre cómo escribir con la sintaxis de Markdown.
198
+
Consulta [Formatear texto](/es/create/text) y [Formatear código](/es/create/code) para obtener más información sobre cómo escribir usando la sintaxis de MDX.
![locadex-agent[bot]](https://avatars.githubusercontent.com/in/1436158?v=4&size=40){kind=avatar}
0 commit comments