Utilización de la interfaz de usuario del verificador de REST XAPI HTTP

Este tema proporciona detalles sobre cómo utilizar la interfaz de usuario de HTTP REST XAPI Tester.

1. Acceda a la interfaz de usuario de HTTP REST XAPI Tester utilizando este URL https://<hostname>:<portno>/smcfs/yfshttpapi/ibmapitester.jsp
2. En el desplegable Nombre de API , seleccione la API REST que desea probar. Una vez seleccionada una API REST, el campo URL BASE se rellena automáticamente con la vía de acceso base de la API REST.
   Nota: Puesto que el valor del campo BASE URL se restablece siempre que seleccione una nueva API REST desde el desplegable Nombre de API , asegúrese de actualizar el valor en el campo BASE URL prefijándolo con "https://<hostname>:<portno>" antes de realizar la llamada de API para la prueba. Por lo tanto, el valor debe estar en el formato https://<hostname>:<portno>/smcfs/restapi/<resource_group> .

   Nota: Solo puede probar las API REST listadas en el Javadoc de REST XAPI desde la interfaz de usuario de HTTP REST XAPI Tester. Puede omitir todas las API no REST que aparecen en la lista desplegable.
3. Especifique el nombre de usuario en el campo UserId y la contraseña en el campo Contraseña .
4. Seleccione el formato (JSON o XML) del mensaje de entrada para la XAPI REST en el campo Content-Type . El tipo de contenido es el tipo de contenido del mensaje o el cuerpo de la solicitud.
   Nota: Para la solicitud GET, si se selecciona un Content-Type , la casilla de verificación Enviar a través de POST se selecciona automáticamente y también se inhabilita. Por lo tanto, para utilizar estos métodos sin enviar a través de POST, asegúrese de que no haya ningún valor seleccionado para el campo Content-Type .
5. Si desea enviar la solicitud a través de POST, seleccione la casilla de verificación Enviar a través de POST .
6. Seleccione el formato (JSON o XML) del mensaje de salida esperado de la XAPI REST en el campo Formato de salida .
7. Opcional: Utilice el Identificador para GET, PATCH o DELETE REST XAPIs. Por ejemplo, puede llamar a la XAPI REST getOrderDetails en un registro con OrderHeaderKey=TestOrder. TestOrder es el identificador en este ejemplo. La infraestructura de HTTP REST XAPI Tester añade este valor de identificador al final del URL base. Por lo tanto, la URL de base completa es la siguiente: https://<hostname>:<portno>/smcfs/restapi/order/TestOrder.
8. Opcional: Los servicios también se pueden probar especificando el nombre de servicio en el campo Nombre de servicio y seleccionando el recuadro de selección Es un servicio .
9. Opcional: El desplegable Historial se puede utilizar para seleccionar una llamada de API anterior. Al seleccionar una API, los campos Mensaje, URL base y Content-Type se rellenan con los valores utilizados en dicha llamada de API.
   Nota: Puesto que el valor del campo BASE URL se restablece siempre que seleccione una nueva API en el desplegable Historial , asegúrese de actualizar el valor en el campo BASE URL añadiendo el prefijo "https://<hostname>:<portno>" antes de realizar la llamada de API para la prueba. Por lo tanto, el valor debe estar en el formato https://<hostname>:<portno>/smcfs/restapi/<resource_group> .
10. Opcional: Para guardar los detalles de una llamada de API, pulse Guardar llamadas de API. El sistema solicita al usuario que guarde el archivo como Apicalls.txt. Este archivo contiene el historial actual de la entrada o la salida de una llamada de API. A continuación, cada llamada de API se indica mediante códigos <!- - start -- > and <! - - end - - > en el archivo, con el nombre de la API invocada listado después del comentario de inicio.
11. Especifique el mensaje de entrada (XML o JSON) en el XAPI REST en el campo Mensaje
12. Pulse Probar XAPI REST ahora. El mensaje de salida (XML o JSON) se visualiza en el recuadro de texto en el lado derecho.