Qt HTTP Server
Qt HTTP Server supports building HTTP server functionality into an application. Common use cases are exposing the application's functionality through REST APIs, or making devices in a trusted environment configurable also via HTTP. The limitations are described in Limitations & Security.
Qt HTTP Server provides building blocks for embedding a lightweight HTTP server based on RFC 2616 in an application. There are classes for the messages sent and received, and for the various parts of an HTTP server.
An HTTP server can be created by subclassing the QAbstractHttpServer class and overriding the handleRequest() function. The QAbstractHttpServer class provides functions for listening to incoming ports or binding to an existing QTcpServer. Dispatching to callables based on incoming URLs can be simplified by using the QHttpServerRouter class.
This can be simplified even further by using the QHttpServer class. The QHttpServer class is a subclass of QAbstractHttpServer and defines an overloaded route function to bind callables to different incoming URLs, and an afterRequest() function to process the response further.
Runtime logging can be configured as described here.
Qt HTTP Server does not have many of the more advanced features and optimizations that general-purpose HTTP servers have. It also has not seen the same scrutiny regarding various attack vectors over the network. Use Qt HTTP Server, therefore, only for local connections or in a trusted network, and do not expose the ports to the internet.
You can add HTTPS support as a basic security measure, though. If Qt is compiled with support for TLS, you can bind QAbstractHttpServer and its subclasses to a QSslServer object, providing Transport Layer Security handling. This can also be achieved by calling the QAbstractHttpServer::sslSetup() function before calling listen().
Using a Qt module requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.
find_package() command to locate the needed module components in the Qt6 package:
find_package(Qt6 REQUIRED COMPONENTS HttpServer) target_link_libraries(mytarget PRIVATE Qt6::HttpServer)
See also the Build with CMake overview.
To configure the module for building with qmake, add the module as a value of the QT variable in the project's .pro file:
QT += httpserver
The module provides the following Examples as a guide to using the API.
© 2024 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.