Tutorial: Mapeo de contenido JSON

Este tutorial muestra cómo asignar el contenido de un mensaje de un formato o esquema a otro formato o esquema.

Antes de empezar

Esta tarea puede ser realizada por usuarios que tengan asignado uno de los siguientes roles:

Propietario de catálogo
Desarrollador

Nota: El catálogo Sandbox debe configurarse para utilizar DataPower® Gateway (v5 compatible) , DataPower API Gateway o ambos. Véase Creación y configuración de catálogos.

Acerca de esta guía de aprendizaje

En este tutorial vas a completar las siguientes lecciones:

Crear una API nueva
Mapear contenido JSON

Crear una API nueva

Siga los siguientes pasos para crear una nueva API.

Inicie sesión en API Manager.
En la página de inicio, haga clic en el mosaico Desarrollar API y productos.
También puede hacer clic en el icono Revelar del panel izquierdo.
En la página Desarrollo, haga clic en Añadir > API.
En la página Seleccionar tipo de API,
1. Asegúrese de que OpenAPI 2.0 está seleccionado.
2. Seleccione el botón de opción Nuevo OpenAPI.
3. Pulse Siguiente.
En la página Crear nueva OpenAPI, introduzca la siguiente información sobre la API.
Nota: El campo OpenAPI Version está predefinido. No puede actualizar este campo.
1. En el campo Título, introduzca Mapper.
  El campo Nombre se rellena con el valor que introduzca en el campo Título.
2. En el campo Versión, introduzca 1.0.0.
3. En el campo Ruta base, introduzca /map .
4. Pulse Siguiente.
En la sección Seguro,
1. Las casillas Secure using Client ID y CORS se seleccionan por cada usuario. No anule la selección de las casillas.
2. Pulse Siguiente.
  
  Verá el progreso a medida que se crea la nueva API. Cuando se crea la API, aparece un Resumen.
En la sección Resumen, haga clic en Editar API.

Aparecerá la pestaña Diseño del borrador de su definición de API.
En el panel izquierdo, haga clic en Consumos.
En el panel derecho, en la sección Consumos,
1. Pulse Añadir +.
2. En el cuadro de diálogo Añadir esquema, en la lista desplegable Tipo Mime (opcional), seleccione application/json y, a continuación, haga clic en Añadir.
En el panel izquierdo, haga clic en Productos.
En el panel derecho, en la sección Produce,
1. Pulse Añadir +.
2. En el cuadro de diálogo Añadir esquema, en la lista desplegable Tipo Mime (opcional), seleccione application/json y, a continuación, haga clic en Añadir.
En el panel izquierdo, haga clic en Rutas.
En el panel derecho, en la sección Rutas,
1. Pulse Añadir +.
2. En el campo Nombre de ruta, introduzca /jsonmap y haga clic en Añadir.
En el panel izquierdo, debajo de la ruta recién creada (/jsonmap ), junto a Operaciones, haga clic en el icono +.
Aparecerá el cuadro de diálogo Añadir esquema.
En el cuadro de diálogo Añadir esquema, realice las siguientes tareas.
1. En el campo Verbo(Clave)(opcional), introduzca get.
2. En el campo Operación (opcional), introduzca POST.
3. Pulse Añadir.
En el panel izquierdo, junto a Parámetros, haga clic en el icono +.
Aparecerá el cuadro de diálogo Añadir esquema.
En el cuadro de diálogo Añadir esquema, realice las siguientes tareas.
1. En el campo Nombre, introduzca body.
2. Seleccione la casilla Obligatorio.
3. En la lista desplegable Situado en, seleccione body.
4. Pulse Añadir.
Desplácese hasta la sección Esquema y haga clic en Ver.
En la sección Esquema, realice las siguientes tareas.
1. En el campo Título (opcional), introduzca body.
2. En la lista desplegable Tipo, seleccione cadena.
3. En la esquina superior derecha, haga clic en Guardar.
En el panel izquierdo, expanda Rutas > Operaciones > Respuestas.
En Respuestas, haga clic en 200.
En el panel derecho, en la sección 200, realice las siguientes tareas.
1. En el campo Nombre (Clave ), introduzca 200.
2. En el campo Descripción, introduzca 200 OK.
3. En la esquina superior derecha, haga clic en Guardar.

Mapear contenido JSON

Haga clic en la pestaña Pasarela.
Para eliminar la política existente en el lienzo, sitúe el cursor sobre ella y haga clic en el icono Eliminar .
Nota: Si está utilizando DataPower API Gateway, la política es una política de invocación, mientras que si está utilizando DataPower Gateway (v5 compatible), la política es una política de proxy.
Para ver la paleta, en el panel derecho, haga clic en el icono más .
En la columna Transformaciones, seleccione mapa.
El nodo de la política de mapas se muestra en el lienzo.
Haga clic en el nodo de política de mapas para abrir el cuadro de diálogo de configuración.
Junto a Entradas, haga clic en el icono Editar entradas.
Haz clic en Añadir entrada.
Complete la configuración de la entrada de mapas introduciendo los siguientes valores
1. En el campo Variable de contexto, introduzca request.body.
2. En el campo Nombre, introduzca input.
3. En la lista desplegable Tipo de contenido, seleccione application/json.
4. En la lista desplegable Definición, seleccione Inline schema.
  Aparecerá la ventana emergente Proporcionar un esquema.
5. En la ventana emergente Proporcionar un esquema, realice las siguientes tareas.
  1. Seleccione la pestaña Generar a partir de JSON de muestra.
  2. Pegue el siguiente ejemplo de JSON en la casilla.
```
{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}
```
  3. Haga clic en Generar.
  4. Pulse Hecho.
    La ventana emergente se cierra.
6. En el cuadro de diálogo de configuración de la política de mapas, haga clic en Listo para completar la configuración de los mapas.
Junto a la columna Salida, haga clic en el icono Editar salidas .
Haz clic en Añadir salida.
Complete la configuración de la salida del mapa introduciendo los siguientes valores
1. En el campo Variable de contexto, introduzca message.body.
2. En el campo Nombre, introduzca output.
3. En la lista desplegable Tipo de contenido, seleccione application/json.
4. En la lista desplegable Definición, seleccione Inline schema.
  Aparecerá la ventana emergente Proporcionar un esquema.
5. En la ventana emergente Proporcionar un esquema, realice las siguientes tareas.
  1. Seleccione la pestaña Generar a partir de JSON de muestra.
  2. Pegue el siguiente ejemplo de JSON en la casilla.
```
{"order":
{
"date":"12-12-12",
"customer": "John Smith",
"address":
{
"street":"king",
"citystatezip":"lit MA 01469",
"country":"USA"
},
"items":[{"type":"shoes", "color":"black", "qty":2, "price":23.50}]
}
}
```
  3. Haga clic en Generar.
6. Pulse Hecho.
  La ventana emergente se cierra.
7. En el cuadro de diálogo de configuración de la política de mapas, haga clic en Listo para completar la configuración de los mapas.
Pulse Guardar.
En la ventana de configuración de la salida del mapa, en la columna Salida, realice la siguiente tarea.
1. Seleccione el botón de opción de la fecha.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, introduzca el siguiente ejemplo JavaScript.
    new Date().toGMTString()
  2. Pulse Hecho.
2. En la columna Entrada, seleccione el botón de opción Nombre y, a continuación, en la columna Salida, seleccione el botón de opción Cliente.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
3. En la columna Entrada, seleccione el botón de opción Middlename y, a continuación, en la columna Salida, seleccione el botón de opción Cliente.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
4. En la columna Entrada, seleccione el botón de opción Apellido y, a continuación, en la columna Salida, seleccione el botón de opción Cliente.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
5. En la columna Salida, seleccione el botón de opción Cliente.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, en el campo Valor, introduzca el siguiente código de ejemplo.
```
var name = $(input.order.customer.name.firstname) + ' '; 
  if($(input.order.customer.name.middlename)) {
  name += $(input.order.customer.name.middlename) + ' ';}
  name += $(input.order.customer.name.lastname);
  name
```
  2. Pulse Hecho.
6. En la columna Entrada, seleccione el botón de opción Dirección > line1 y, a continuación, en la columna Salida, seleccione el botón de opción Calle.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
7. En la columna Entrada, seleccione el botón de opción Dirección > line2 y, a continuación, en la columna Salida, seleccione el botón de opción Calle.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
8. En la columna Salida, seleccione el botón de opción Calle.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, en el campo Valor, introduzca el siguiente código de ejemplo.
```
var street = $(input.order.customer.address.line1) + ' '; 
  if($(input.order.customer.address.line2)) {
  street += $(input.order.customer.address.line2);}
  street
```
  2. Pulse Hecho.
9. En la columna Entrada, seleccione el botón de opción ciudad y, a continuación, en la columna Salida, seleccione el botón de opción ciudadestadozip.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
10. En la columna Entrada, seleccione el botón de opción Estado y, a continuación, en la columna Salida, seleccione el botón de opción Ciudad-Estado-Código postal.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
11. En la columna Entrada, seleccione el botón de opción Código y, a continuación, en la columna Salida, seleccione el botón de opción Código postal.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
12. En la columna Salida, seleccione el botón de opción Calle.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, en el campo Valor, introduzca el siguiente código de ejemplo.
```
$(1) + " " + $(2) + " " + $(3)
```
    Nota: Las referencias a variables son posicionales; $(1) se refiere al primer valor asignado (input.order.customer.city), y así sucesivamente.
  2. Pulse Hecho.
13. En la columna Entrada, seleccione el botón de opción Elementos > elemento y luego, en la columna Salida, seleccione el botón de opción Elementos.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, active la casilla Cadena vacía como valor predeterminado.
  2. Pulse Hecho.
14. En la columna Salida, haga clic en la segunda propiedad Añadir.
  1. En el primer campo, introduzca total.
  2. En la lista desplegable, seleccione float.
  3. Haz clic en el icono +.
15. En la columna Entrada, seleccione el botón de opción Elementos y, a continuación, en la columna Salida, seleccione el botón de opción Total.
  Aparece el cuadro de diálogo Configurar asignación.
  1. En el cuadro de diálogo Configurar asignación, en el campo Valor, introduzca el siguiente código de ejemplo.
```
$(0) + ($(input.items.price) * $(input.items.qty))
```
  2. Pulse Hecho.
16. En la página de salida del nodo de política de mapas, haga clic en Guardar.
Haga clic en la fuente.
Desplácese hacia abajo y localice el código donde se calcula el total.
Inserte una nueva línea con el código foreach: input.items.
Pulse Guardar.

Probar la definición de API

Nota: Debido a las restricciones de Cross-Origin Resource Sharing (CORS), la herramienta de prueba de ensamblaje no puede utilizarse con los navegadores Chrome o Safari en la plataforma macOS Catalina.

Para probar su definición de API utilizando la herramienta de prueba del Gestor de API, siga los siguientes pasos:

Haz clic en Ensamblar.
Haga clic en el icono Prueba . Se abre la herramienta de prueba.
Haga clic en Activar API.
En el campo Operación, seleccione post /jsonmap.

En el campo cuerpo, introduzca el siguiente texto JSON.

{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}

Prueba de selección op

Haga clic en Invocar. Se visualizará la respuesta. Tenga en cuenta que los valores de los campos date, street, citystatezip, y total reflejan las fórmulas de asignación que definió anteriormente.
Nota: Si utiliza un certificado autofirmado, es posible que se le pida que visite un sitio web proporcionado URL. Haga clic en el enlace y acepte el certificado antes de volver al Gestor de API y hacer clic de nuevo en Invocar.

Gestione la definición de su API

Ahora que su nueva API funciona como es debido, puede empezar a gestionarla. Para ver sus opciones inmediatas, realice los siguientes pasos.

En el panel de navegación, haga clic en el icono Revelar .
Junto a la API Mapper, haga clic en el icono Menú y seleccione Descargar.

Qué ha hecho en esta guía de aprendizaje

Creada una nueva API
Contenido mapeado de un esquema JSON a otro esquema.