En esta página

Qt Quick Demostración: cliente de API RESTful

Ejemplo de cómo crear un cliente QML para una API RESTful.

Una interfaz gráfica de usuario (GUI) para un servicio de paletas de colores

Este ejemplo muestra cómo crear un cliente QML básico para una API RESTful con un servicio imaginario de paleta de colores. La aplicación utiliza la comunicación RESTful con un servidor local para solicitar y enviar datos. El servicio REST se proporciona como un elemento QML cuyos elementos hijos envuelven las API de datos JSON individuales proporcionadas por el servidor.

Ejecución del ejemplo

Puedes ejecutar el ejemplo desde:

Funcionalidad de la aplicación

El ejemplo ofrece las siguientes funcionalidades básicas:

  • Mostrar una lista de usuarios y colores
  • Iniciar y cerrar sesión de los usuarios
  • Modificar y crear nuevos colores
Ejecución del servidor

El cliente se comunica con el servidor de ejemplo de la API REST basada en Qt que se encuentra en QtHttpServer, el cual escucha en el puerto http://127.0.0.1:49425. Inicia ese servidor antes de ejecutar el cliente.

El cliente se conecta al iniciarse y envía una solicitud HTTP GET a la API de colores. Si no se puede acceder al servidor, un cuadro de diálogo informa del fallo en la conexión y te permite volver a intentarlo una vez que el servidor esté en funcionamiento.

El servidor de la API REST basado en Qt es una aplicación con estado que permite modificar los colores, y los cambios se conservan mientras el proceso del servidor esté en ejecución.

Listar usuarios y colores

Los usuarios y los colores son recursos paginados en el lado del servidor. Esto significa que el servidor proporciona los datos en bloques denominados «páginas». La interfaz de usuario refleja esta paginación y muestra los datos por páginas.

La visualización de los datos en la interfaz de usuario se realiza mediante vistas QML estándar:

ListView {
    id: colorListView

    model: root.colors.data

Donde el modelo es una lista de datos JSON recibidos del servidor.

Inicio de sesión

El inicio de sesión se realiza a través de la función de inicio de sesión que ofrece la ventana emergente de inicio de sesión:

userMenu.userLoginService.login({"email" : userInfo.modelData.email,
                    "password" : "apassword",
                    "id" : userInfo.modelData.id})

En segundo plano, el inicio de sesión envía una solicitud HTTP POST. Al recibir una respuesta satisfactoria, se extrae el token de autorización de la respuesta, que luego se utiliza en las solicitudes HTTP posteriores que requieran dicho token.

Una interfaz gráfica de usuario que muestra la lista de usuarios

Edición de colores

La edición y la adición de nuevos colores se realizan en una ventana emergente:

Una interfaz gráfica de usuario para editar un color

Ten en cuenta que para subir los cambios de color al servidor es necesario que el usuario haya iniciado sesión.

Implementación REST

El ejemplo ilustra una forma de componer un servicio REST a partir de elementos de recursos individuales. En este ejemplo, los recursos son los recursos paginados user y color, además del servicio de inicio de sesión. Los elementos de los recursos están vinculados entre sí por la URL base (URL del servidor) y el gestor de acceso a la red compartido.

La base del servicio REST es el elemento RestService, cuyos elementos hijos componen el servicio propiamente dicho:

RestService {
    id: paletteService
    url: window.serverUrl

    PaginatedResource {
        id: users
        path: "users"
    }

    PaginatedResource {
        id: colorPalette
        path: "unknown"
    }

    BasicLogin {
        id: colorLogin
        loginPath: "login"
        logoutPath: "logout"
    }
}

Al instanciarse, el elemento RestService recorre sus elementos hijos y los configura para que utilicen el mismo gestor de acceso a la red. De este modo, los recursos individuales comparten los mismos datos de acceso, como la URL del servidor y el token de autorización.

La comunicación propiamente dicha se lleva a cabo mediante un gestor de acceso REST que implementa algunas funciones prácticas para gestionar específicamente las API REST HTTP y se encarga de forma eficaz de enviar y recibir las solicitudes QNetworkRequest y QNetworkReply según sea necesario.

Archivos fuente

Proyecto de ejemplo en code.qt.io

Véase también Todos los ejemplos de Qt XML y Ejemplos y tutoriales deQt Quick .

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.