|
|
|
|
|
|
|
|
- Presentación
- Importación de servicios web REST mediante la OpenAPI Definition
- Utilización de un servicio web REST importado a través de su OpenAPI Definition
- Opciones para llamar a una función de servicio web
- Propiedades associated con el servicio web
Servicios web REST: Importar una especificación de OpenAPI
Las API de servicios web REST pueden describirse mediante archivos OpenAPl.
Este archivo de documentación puede importarse en el proyecto: el editor de código reconoce las API descritas en el archivo.
Estas API pueden llamarse de forma nativa. Importación de servicios web REST mediante la OpenAPI Definition Para importar un servicio web REST utilizando su OpenAPI Definition: - En el panel "Explorador de proyectos", seleccione "Servicios web importados".
- Haga clic derecho y seleccione "Usar una API". El asistente de importación se abre automáticamente.
- En el asistente, localice el OpenAPI Definition:
- a través de una dirección de Internet: en este caso, puede especificar:
- si se deben ignorar los errores de seguridad HTTPS,
- los parámetros de autenticación, si es necesario.
- a través de un archivo local JSON o YAML.
- A continuación, el servicio web se importa en el proyecto. description aparece en el panel "Explorador de proyectos. Ahora puede utilizar el servicio web REST en el proyecto.
Utilización de un servicio web REST importado a través de su OpenAPI Definition Para manipular un servicio web mediante programación, basta con utilizar su nombre (tal como aparece en el panel "Explorador de proyectos") en el editor de código: todos los procedimientos associated estarán entonces disponibles. Observación: Puede arrastrar el nombre del servicio web desde el panel "Explorador de proyectos" y soltarlo directamente en el editor de código, para insertar el servicio web y sus funciones. Opciones para llamar a una función de servicio web En algunos casos, puede ser necesario definir requisitos previos para la ejecución de una función API, como el uso de cabeceras específicas. También puede definir la Certificate y la contraseña utilizadas, así como el tiempo de espera de la solicitud. Puede definir estos parámetros mediante una Variable de tipo apiRequest. La apiRequest Variable debe utilizarse como primer parámetro de la llamada a la función del servicio web. Propiedades associated con el servicio web Se pueden utilizar varias propiedades con el nombre del servicio web. Estas propiedades están disponibles en modo lectura y escritura. | | | | denominar | Tipo utilizado | Efecto |
|---|
| Address | Cadena de caracteres | Sustituye la dirección de llamada al servicio web descrita en la OpenAPI Document por otra URL. Esta Property es useful si el servicio web está alojado en servidores diferentes. Este Property tiene el siguiente formato: "http://servidor:puerto/ruta_del_servicioweb". Para un servicio web generado con WINDEV y desplegado en un Servidor de aplicaciones WEBDEV, es la URL del archivo de extensión "awws". Observaciones: - El cambio de esta Property anula todas las URL descritas en la OpenAPI Document.
- Si esta Property se define como una cadena vacía (""), se utilizarán las URL descritas en la OpenAPI Document
| | Contraseña | Cadena de caracteres | Contraseña utilizada para la autenticación en las peticiones HTTP enviadas al servicio web.. Este nombre sólo se utiliza si se requiere autenticación para acceder al servidor donde está alojado el servicio web. | | drogadicta | Cadena de caracteres | Nombre de usuario utilizado para la autenticación en las solicitudes HTTP enviadas al servicio web.. Este nombre sólo se utiliza si se requiere autenticación para acceder al servidor donde está alojado el servicio web.
Con el método Negociar autenticación, el dominio debe ser añadido al usuario dependiendo de la configuración.: myWebservice..User = "DOMAIN\User" myWebservice..User = "User@DOMAIN" | | Puerto | Cadena de caracteres | Nombre del puerto definido en la OpenAPI Document. Es el puerto utilizado para comunicarse con el servidor que aloja el servicio web. Contact tu gestor de red o el propietario del servicio web. | | VersionHTTP | Constante de tipo Integer | Versión HTTP utilizada por el servidor: - httpVersion2: HTTP versión 2.0. Si el servidor no admite esta versión, se utiliza una versión anterior.
- httpVersion2Only: Fuerza la versión 2.0 de HTTP: si el servidor no soporta esta versión, se muestra un error fatal.
- httpVersion1_1: Versión HTTP 1.1.
- httpVersion1_0: HTTP versión 1.0.
- httpVersionDefault: HTTP versión 1.0.
|
Esta página también está disponible para…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|