Génération Swagger/OpenAPI pour C++ : meilleurs outils et bibliothèques

Génération Swagger/OpenAPI pour C++ : comment automatiser la création d'API REST

Le développement web moderne en C++ nécessite des outils efficaces pour créer des API REST. La spécification OpenAPI (anciennement Swagger) est devenue la norme pour décrire les interfaces des services web. Cependant, la génération automatique de code en C++ à partir de spécifications OpenAPI est une tâche non triviale. Dans cet article, nous analyserons les meilleures bibliothèques et outils qui vous aideront à générer du code serveur et client en C++ à partir de documents OpenAPI.

Pourquoi le C++ est-il en retard par rapport aux autres langues dans la génération OpenAPI ?

Contrairement à Python, Java ou JavaScript, où il existe des générateurs matures (par exemple, openapi-generator), le C++ est confronté à plusieurs problèmes :

\n
• Absence de standard unique pour les frameworks HTTP — en C++, il n'y a pas de framework web dominant comme Flask ou Spring.
\n
• Complexité de la gestion de la mémoire — la génération de code sécurisé avec des pointeurs intelligents nécessite des modèles supplémentaires.
\n
• Diversité des types — la sérialisation JSON en C++ nécessite une configuration manuelle pour les structures complexes.
\n

Outils principaux pour la génération de code C++ à partir d'OpenAPI

1. OpenAPI Generator (générateur officiel)

L'outil le plus populaire — OpenAPI Generator (anciennement Swagger Codegen). Il prend en charge de nombreux langages, y compris le C++. Cependant, sa prise en charge du C++ est limitée : seul le code client est généré sur la base de cpprestsdk (Casablanca) ou Qt.

Installation :

# Via npm\nnpm install @openapitools/openapi-generator-cli -g\n\n# Génération d'un client C++ (cpprestsdk)\nopenapi-generator generate -i petstore.yaml -g cpp-restsdk -o ./client

Exemple de code généré (Qt) :

// PetApi.h\nclass PetApi : public AbstractOpenAPISchema {\n    Q_OBJECT\npublic:\n    explicit PetApi(QObject *parent = nullptr);\n    \n    void addPet(const Pet &body);\n    void getPetById(qint64 petId);\n    \nsignals:\n    void addPetSignal(Pet &result);\n    void getPetByIdSignal(Pet &result);\n};

Avantages : Prise en charge de nombreux formats, communauté active.
\nInconvénients : Le code généré nécessite souvent des ajustements ; pas de génération serveur pour le C++.

2. oat++ (oatpp) — framework avec prise en charge OpenAPI

oat++ est un framework C++ moderne pour créer des API REST, qui inclut une prise en charge intégrée d'OpenAPI. Contrairement aux générateurs, oat++ utilise une approche déclarative avec des annotations.

Exemple de description d'endpoint :

ENDPOINT("GET", "/users/{userId}", getUser) {\n    auto userId = req->getPathVariable("userId");\n    auto user = userService->getUser(userId);\n    \n    // Documentation automatique OpenAPI\n    auto dto = UserDto::createShared();\n    dto->id = user->id;\n    dto->name = user->name;\n    return createDtoResponse(Status::CODE_200, dto);\n}

Oat++ génère automatiquement le fichier openapi.yaml à partir des annotations. Cela permet de ne pas écrire la spécification manuellement, mais de la déduire du code.

3. Restbed + Swagger UI

Restbed est un framework HTTP léger pour C++11. Associé à la bibliothèque restbed-swagger, il permet de générer dynamiquement la documentation OpenAPI.

#include <restbed>\n#include <restbed-swagger>\n\nauto resource = std::make_shared<restbed::Resource>();\nresource->set_path("/api/users/{id}");\n\n// Description des paramètres pour Swagger\nrestbed::swagger::Info info;\ninfo.set_title("User API");\ninfo.set_version("1.0.0");\n\nauto swagger = std::make_shared<restbed::swagger::Service>(info);\nswagger->publish(resource);

4. Crow — microframework avec extension OpenAPI

Crow —