OpenAPI
La especificación OpenAPI se utiliza para definir las API HTTP. Describe los extremos, las operaciones, los parámetros de entrada y salida, los parámetros de seguridad y otros detalles de una API, normalmente en formato JSON o YAML. MapForce es compatible con la especificación OpenAPI 2.0 (antes conocida como especificación de documentación de API RESTful Swagger), 3.0 y 3.1.
Los ajustes de OpenAPI que puede configurar se muestran en la siguiente imagen. Para más información sobre cada opción de configuración, consulte los subapartados siguientes.
Configuración de OpenAPI
Para rellenar los parámetros de una llamada a un servicio web, deberá proporcionar un archivo OpenAPI que describa el servicio web: Haga clic en Examinar junto al campo Archivo OpenAPI y seleccione el archivo correspondiente. En cuanto seleccione el archivo OpenAPI, las opciones de configuración de este servicio web se rellenarán automáticamente. Si lo necesita, puede cambiar las opciones de configuración. Esto no afectará al archivo OpenAPI.
Archivo OpenAPI | Es la ruta al archivo de especificación OpenAPI que describe el servicio web.
|
Ruta de acceso y Operación | El campo Ruta de acceso se refiere al extremo de una API (por ejemplo, /usuarios) que MapForce necesita para llamar a la función deseada. Todas las rutas son relativas a la URL del servidor API (ver más abajo).
Operaciones se refiere a los métodos HTTP (por ejemplo, GET, DELETE, POST) que se utilizan para realizar diferentes acciones en las rutas de acceso. Seleccione una ruta de acceso y, luego, elija una operación para esa ruta (por ejemplo, POST /users para agregar un nuevo usuario). Puede haber varias rutas disponibles, y para cada ruta, puede haber una o más operaciones definidas.
La ruta de acceso y el funcionamiento se pueden configurar a través del mismo botón Elegir. Cuando pulse este botón, aparecerá un cuadro de diálogo (imagen siguiente) que le pedirá que seleccione una ruta de acceso y una operación para ella. En la imagen siguiente, se ha seleccionado la operación POST para la ruta /pets.
|
Servidor | El campo Servidor hace referencia a la URL base de una API (por ejemplo, https://api.example.com) a la que son relativas las rutas de los extremos (por ejemplo, https://api.example.com/users).
|
De forma predeterminada, los campos Servidor y Ruta de acceso seleccionados se concatenan para formar la URL en la Configuración de la conexión (ver más abajo).
Configuración de la conexión
URL | URL especifica la dirección (URL) del servicio web al que desea llamar.
| ||
Usar URL dinámicas dadas por la asignación | Si quiere suministrar la URL del servicio web desde una asignación, marque la casilla Usar URL dinámicas dadas por la asignación. Esto crea otro conector de entrada en el componente del servicio web dentro de la asignación al que puede conectar un componente de entrada que proporcione la URL del servicio web.
Con las URL total o parcialmente dinámicas, puede ajustarlas con flexibilidad en función de lo que necesite. Por ejemplo, puede ejecutar la asignación con una URL específica durante el desarrollo y usar una URL diferente en producción, sin tener que modificar la asignación. Esto sería posible con una URL como https://{host}/some/path/to/service, siempre que el nombre de host sea la única diferencia entre la URL de desarrollo y la de producción, y que la suministre como parámetro de la asignación. Observe que las URLs parcialmente dinámicas requieren una validación más escrita, ya que solo se reemplazan con valores asignables o en tiempo de ejecución las partes designadas de la URL.
Con las URLs completamente dinámicas se puede asignar toda la URL y tiene control absoluto sobre ella; el único requisito es que la URL empiece por http:// o https:// y que sea un URL válido. Es decir, con las URLs dinámicas puede suministrar la URL devuelta por una llamada a un servicio web como entrada de otro componente que puede llamar al mismo servicio web (o a otro).
| ||
Tiempo de espera | El parámetro Tiempo de espera define el plazo de tiempo pasado el cual la llamada al servicio web expirará si no se obtiene respuesta del servidor. Seleccione Infinito si la llamada debe esperar una respuesta durante un plazo indefinido de tiempo.
|
Notas sobre los parámetros en la URL
Opcionalmente, puede convertir partes específicas de la URL en parámetros y suministrar valores a estos parámetros desde la asignación principal. Si la URL del servicio web usa esos parámetros, debe tener en cuenta que:
•Si llama a un servicio web con parámetros de estilo plantilla o matriz, ponga los parámetros entre llaves, por ejemplo: http://example.org/api/products/{id}. Después defina la configuración de cada parámetro en la tabla Parámetros. En tiempo de ejecución, MapForce procesa los nombres de parámetro que están entre llaves y produce la URL final que incluye valores reales.
•Si llama a un servicio web con parámetros de consulta URL (por ejemplo, http://example.org/api/products?sort=asc&category=1&page=1), no introduzca la parte de consulta en el cuadro de texto URL. En su lugar, defina los parámetros en la tabla Parámetros y asegúrese de designarlos como parámetros de tipo consulta.
Parámetros
Los parámetros definidos en el archivo OpenAPI se muestran en la sección Parámetros del cuadro de diálogo Configuración de la llamada al servicio web (imagen siguiente). Para cada parámetro, debe definir si el parámetro es asignable o tiene un valor fijo, pero no debe modificar ningúna otra opción de configuración de los parámetros definidos por OpenAPI a menos que sean incorrectos.
Si se ha actualizado el archivo OpenAPI y el servicio ha recibido parámetros adicionales o diferentes, pulse el botón Restaurar para actualizar los parámetros.
En cuanto a agregar nuevos parámetros, por lo general solo tendrá que agregar los que falten y no estén documentados en la sección Parámetros.
Para más detalles sobre qué opciones de configuración puede definir en la sección Parámetros, consulte Parámetros.
Configuración de seguridad HTTP
Puede que necesite configurar las opciones de configuración de seguridad HTTP en estas situaciones:
•Al servicio web se le llama a través de HTTPS y requiere un certificado de cliente.
•El servidor utiliza un certificado incorrecto y a usted le gustaría permitir un nombre de host no coincidente entre el certificado y la solicitud.
•El servicio web requiere autenticación HTTP básica o autorización OAuth 2.0.
Para más información, consulte Configuración de seguridad HTTP.
Guardar todas las rutas de acceso de archivos como relativas al archivo MFD
Cuando esta opción está habilitada, MapForce guarda las rutas de acceso al archivo que aparecen en el cuadro de diálogo Configuración del componente relativas a la ubicación del archivo de diseño de MapForce (.mfd). Consulte también Rutas de acceso relativas y absolutas.