En esta página

Qt OpenAPI

El módulo Qt OpenAPI ofrece funcionalidad para generar clientes HTTP de Qt utilizando las API RESTful de Qt Network. Las principales características del módulo son el generador Qt OpenAPI y la biblioteca OpenApiCommon pregenerada.

El generador de Qt OpenAPI es un complemento del generador de OpenAPI. Permite generar automáticamente clientes HTTP de Qt en C++ utilizando Qt Network API como QRestAccessManager.

Nota: El generador Qt OpenAPI utiliza la especificación OpenAPI 3.1.1 como referencia. Esto afecta a características como los parámetros de operación y las propiedades de modelo que admiten valores nulos.

Nota: Qt OpenAPI en la versión 6.12 se encuentra en fase de «Technology Preview», por lo que su API queda excluida de las garantías de compatibilidad de Qt.

Uso del módulo

Para utilizar el módulo Qt OpenAPI es necesario instalar los siguientes paquetes:

/note El código generado por el generador Qt OpenAPI puede variar según la versión, ya que depende de la versión del generador OpenAPI original que se esté utilizando en ese momento. Es posible que las versiones más antiguas del generador no sean compatibles con algunas de las funciones.

Una vez realizadas las instalaciones necesarias, el generador de Qt OpenAPI estará listo para su uso en tus proyectos. Para generar código de cliente a partir de una especificación OpenAPI utilizando el generador de Qt OpenAPI, llama a la función `qt_add_openapi_client` dentro del archivo `CMakeLists.txt` de tu proyecto. Consulta «Compilación con CMake» para obtener más detalles.

Compilación con CMake

Uso de la función ` qt_add_openapi_client `

Utilice el comando ` find_package() ` para localizar los componentes del módulo necesarios en el paquete Qt6. A continuación, llame a la función ` qt_add_openapi_client ` para generar la biblioteca de cliente HTTP de Qt necesaria. Consulte el ejemplo completo de código CMake a continuación:

cmake_minimum_required(VERSION 3.22)

project(openapiApplication LANGUAGES CXX)

set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

find_package(Qt6 REQUIRED COMPONENTS Core OpenApiCommon OpenApiTools)

qt_add_executable(openapiApplication
  main.cpp
)
qt_add_library(generatedLibrary)
qt_add_openapi_client(generatedLibrary
    SPEC_FILE
        ${CMAKE_CURRENT_SOURCE_DIR}/spec.yaml
)
target_link_libraries(openapiApplication PRIVATE Qt6::Core generatedLibrary)

include(GNUInstallDirs)
install(TARGETS openapiApplication
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
)

Nota: No es necesario vincular la biblioteca` OpenApiTools ` al objetivo resultante ` openapiApplication `. Sin embargo, sigue siendo necesaria para habilitar la función CMake ` qt_add_openapi_client `.

Nota: La biblioteca` OpenApiCommon ` se vincula al objetivo mediante la llamada a ` qt_add_openapi_client `.

Ejecución del generador Qt OpenAPI desde la línea de comandos

Para generar código de cliente a partir de una especificación OpenAPI utilizando el generador Qt OpenAPI, debes ejecutar el siguiente comando:

java -cp <path-to-installed-openapigen>/openapi-generator-cli.jar:<path-to-installed-qt>/<qt-version>/libexec/cpp-qt6-client-openapi-generator.jar \
org.openapitools.codegen.OpenAPIGenerator \
generate -g cpp-qt6-client \
--additional-properties=cppCommonNamespace=QtOpenApiCommon,prefix=QOAI \
-o generator_output/ -i file.yaml

El comando anterior añade el generador Qt OpenAPI a la ruta de clases, lo que lo hace visible para el generador OpenAPI de origen, y a continuación invoca la clase principal org.openapitools.codegen.OpenAPIGenerator. Al establecer el nombre del generador Qt OpenAPI, cpp-qt6-client, en el parámetro -g, se garantiza que se encuentre y se invoque.

Para generar código de cliente a partir de un archivo de especificación OpenAPI de gran tamaño, añade la opción maxYamlCodePoints a la línea de comandos, como se muestra a continuación:

java -DmaxYamlCodePoints=99999999 <other arguments>

Nota: Añadesiempre --additional-properties=cppCommonNamespace=QtOpenApiCommon,prefix=QOAI si deseas vincular la biblioteca Qt6::OpenApiCommon pregenerada al proyecto, ya que se ha compilado con estos parámetros y se producirán errores de compilación si se proporcionan valores diferentes.

El generador crea la biblioteca de cliente en la carpeta generator_output. Añade la carpeta generator_output al proyecto, tal y como se muestra en el siguiente ejemplo:

find_package(Qt6 REQUIRED COMPONENTS Core OpenApiCommon)
add_subdirectory(generator_output/client)
add_executable(example_binary
  main.cpp
)
target_link_libraries(Qt6OpenAPIClient PUBLIC Qt6::OpenApiCommon)
target_link_libraries(example_binary PRIVATE Qt6::Core Qt6OpenAPIClient)

Si desea ver todas las opciones de generación, puede utilizar la opción config-help; consulte a continuación:

java -cp <path-to-installed-openapigen>/openapi-generator-cli.jar:<path-to-installed-qt>/<qt-version>/libexec/cpp-qt6-client-openapi-generator.jar \
org.openapitools.codegen.OpenAPIGenerator config-help -g cpp-qt6-client

Nota: Puede encontrar más información sobre el uso del generador en la documentación del generador OpenAPI.

Consideraciones de seguridad

Al utilizar Qt OpenAPI, ten en cuenta los siguientes aspectos relacionados con la seguridad:

Ejemplos

Referencia

Este módulo proporciona herramientas de compilación (comandos de CMake) en lugar de una API de C++ en tiempo de ejecución. Consulta «Comandos de CMake en Qt6 OpenAPI» para ver los comandos disponibles.

Licencias y atribuciones

Las distintas partes del módulo Qt OpenAPI están disponibles bajo diferentes licencias.

La biblioteca Qt OpenApiCommon está disponible bajo licencias comerciales de The Qt Company. Además, está disponible bajo la Licencia Pública General Reducida de GNU, versión 3, o la Licencia Pública General de GNU, versión 2. Consulta «Licencias de Qt» para obtener más detalles.

El complemento Qt OpenAPI Generator, junto con los archivos de plantilla para la generación de código (que tienen la extensión .mustache ), se derivan del proyecto original OpenAPI Generator y están sujetos a la Licencia Apache 2.0.

© 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.