Revision control
Copy as Markdown
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\title Qt OpenAPI
\page qtopenapi-index.html
\brief Qt OpenAPI module provides functionality for generating Qt HTTP clients.
{OpenAPI generator} which allows you to generate clients, servers, and
documentation from OpenAPI 2.0/3.x specifications using a variety of programming
languages and frameworks.
The Qt6 OpenAPI generator allows you to autogenerate Qt HTTP clients
in C++ using \l{Qt Network} APIs such as \l QRestAccessManager.
\section1 Using the module
Installation of the following packages is necessary to use the Qt OpenAPI module:
\list
(requires OpenAPI 7.12.0 or above).
\endlist
Once you have the required installations, the Qt OpenAPI generator
is ready for use within your projects.
To generate client code from an OpenAPI specification
using the Qt OpenAPI Generator, you should call the
\c qt6_add_openapi_client macro inside your project's
CMakeLists.txt file. See \l {Building with CMake} for details.
\section2 Building with CMake
\section1 Examples
\section1 Licenses and Attributions
*/