Servidor de API RESTful
Ejemplo de cómo crear un servidor API RESTful utilizando la clase ` QHttpServer`.

Este ejemplo muestra cómo crear y alojar API web RESTful sencillas en una pequeña aplicación utilizando la clase QHttpServer. Este servidor acepta llamadas en estilo REST y puede utilizarse junto con su contraparte, el ejemplo de cliente de la API RESTful Color Palette, en el lado del cliente.
Una aplicación que cumple las restricciones de REST puede describirse de manera informal como «RESTful». El servidor de API RESTful permite operaciones de creación, lectura, actualización y eliminación de colores (recurso desconocido para que sea compatible con la API de Reqres) y de usuarios. El servidor de API RESTful también ofrece la funcionalidad de inicio y cierre de sesión. El ejemplo se basa en la API de Reqres.
Para ejecutar la aplicación del servidor, ejecuta el binario del servidor:
./colorpaletteservero
./colorpaletteserver --port 1234Se puede proporcionar un parámetro opcional « port » para especificar el puerto en el que se ejecutará el servidor.
httpServer.route(
QString("%1").arg(apiPath), QHttpServerRequest::Method::Get,
[&api](const QHttpServerRequest &request) { return api.getPaginatedList(request); });En el ejemplo anterior, se especifica la ruta para el método GET, que devuelve una matriz JSON con una lista paginada de los elementos almacenados. Para ello, se utiliza el método QHttpServer::route() con la enumeración QHttpServerRequest::Method::Get.
httpServer.route(QString("%1/<arg>").arg(apiPath), QHttpServerRequest::Method::Get,
[&api](qint64 itemId) { return api.getItem(itemId); });Para obtener un único elemento de la lista de entidades, se pasa el ID del elemento en la consulta de la solicitud.
httpServer.route(QString("%1").arg(apiPath), QHttpServerRequest::Method::Post,
[&api, &sessionApi](const QHttpServerRequest &request) {
if (!sessionApi.authorize(request)) {
return QHttpServerResponse(
QHttpServerResponder::StatusCode::Unauthorized);
}
return api.postItem(request);
});En este ejemplo, la ruta acepta el método POST, que añade una nueva entrada a la lista de elementos y devuelve un objeto JSON que representa la entrada añadida. Esta solicitud debe estar autorizada. Para autorizar la solicitud, el valor del encabezado TOKEN debe ser igual al token devuelto previamente por los métodos api/login o api/register.
QHttpServerResponse postItem(const QHttpServerRequest &request)
{
const std::optional<QJsonObject> json = byteArrayToJsonObject(request.body());
if (!json)
return QHttpServerResponse(QHttpServerResponder::StatusCode::BadRequest);
const std::optional<T> item = factory->fromJson(*json);
if (!item)
return QHttpServerResponse(QHttpServerResponder::StatusCode::BadRequest);
if (data.contains(item->id))
return QHttpServerResponse(QHttpServerResponder::StatusCode::AlreadyReported);
const auto entry = data.insert(item->id, *item);
return QHttpServerResponse(entry->toJson(), QHttpServerResponder::StatusCode::Created);
}Además de la nueva entrada como objeto JSON, los métodos POST también devuelven diferentes códigos de estado HTTP: « Created » para las entradas nuevas, o « AlreadyReported » para las entradas ya existentes. Este ejemplo utiliza una sobrecarga de « QHttpServerResponse::QHttpServerResponse » para enviar un objeto JSON y el código de estado HTTP correspondiente.
Para crear una entrada, el cuerpo de la solicitud debe ser un objeto JSON con los campos email, first_name, last_name y avatar —para crear nuevos usuarios—. Por ejemplo:
{
"email": "jane.doe@qt.io",
"first_name": "Jane",
"last_name": "Doe",
"avatar": "/img/faces/1-image.jpg"
}Archivos:
- colorpalette/CMakeLists.txt
- colorpalette/apibehavior.h
- colorpalette/colorpalette.pro
- colorpalette/main.cpp
- colorpalette/types.h
- colorpalette/utils.h
Imágenes:
- colorpalette/assets/img/1-image.jpg
- colorpalette/assets/img/10-image.jpg
- colorpalette/assets/img/11-image.jpg
- colorpalette/assets/img/12-image.jpg
- colorpalette/assets/img/2-image.jpg
- colorpalette/assets/img/3-image.jpg
- colorpalette/assets/img/4-image.jpg
- colorpalette/assets/img/5-image.jpg
- colorpalette/assets/img/6-image.jpg
- colorpalette/assets/img/7-image.jpg
- colorpalette/assets/img/8-image.jpg
- colorpalette/assets/img/9-image.jpg
© 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.