FastComments C++ SDK

Использование аутентифицированных API (DefaultAPI)

Важно:

1. Вы должны установить базовый URL (генератор cpp-restsdk не читает его из спецификации OpenAPI)
2. Вы должны установить ваш API‑ключ в ApiClient перед выполнением аутентифицированных запросов. Если вы этого не сделаете, запросы завершатся ошибкой 401.

#include <iostream>
#include "FastCommentsClient/api/DefaultApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"

int main() {
    auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();

    // REQUIRED: Установите базовый URL (выберите ваш регион)
    config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));  // US
    // OR: config->setBaseUrl(utility::conversions::to_string_t("https://eu.fastcomments.com"));  // EU

    // REQUIRED: Установите ваш API‑ключ
    config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_API_KEY_HERE"));

    auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
    org::openapitools::client::api::DefaultApi api(apiClient);

    // Теперь делайте аутентифицированные вызовы API
    return 0;
}

Использование публичных API (PublicAPI)

Публичные конечные точки не требуют аутентификации:

#include <iostream>
#include "FastCommentsClient/api/PublicApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"

int main() {
    auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();

    // REQUIRED: Установите базовый URL
    config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));

    auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
    org::openapitools::client::api::PublicApi publicApi(apiClient);

    // Выполняйте публичные API вызовы
    return 0;
}

Использование API модерации (ModerationApi)

ModerationApi обслуживает панель модератора. Каждый метод принимает параметр sso, поэтому вызов выполняется от имени модератора, аутентифицированного через SSO (см. раздел SSO ниже, чтобы узнать, как создать токен):

#include <iostream>
#include "FastCommentsClient/api/ModerationApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"

int main() {
    auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();

    // REQUIRED: Установите базовый URL
    config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));

    auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
    org::openapitools::client::api::ModerationApi moderationApi(apiClient);

    // Передайте SSO‑токен модератора для аутентификации вызова
    auto ssoToken = utility::conversions::to_string_t("YOUR_MODERATOR_SSO_TOKEN");

    org::openapitools::client::api::GetCountOptions options;
    options.sso = ssoToken;

    auto response = moderationApi.getCount(options).get();

    return 0;
}

Общие проблемы

1. Ошибка "URI must contain a hostname": Убедитесь, что вы вызываете config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com")) перед созданием ApiClient. Генератор cpp-restsdk не читает автоматически URL сервера из спецификации OpenAPI.
2. Ошибка 401 "missing-api-key": Убедитесь, что вы вызываете config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_KEY")) перед созданием экземпляра DefaultAPI.
3. Неправильный класс API: Используйте DefaultApi для серверных аутентифицированных запросов, PublicApi для клиентских/публичных запросов и ModerationApi для запросов панели модератора (аутентифицированных с помощью SSO‑токена модератора).

All API methods in this SDK return pplx::task<std::shared_ptr<ResponseType>> from the C++ REST SDK. This gives you flexibility in how you handle API responses.

Синхронные вызовы с .get()

Use .get() to block the calling thread until the request completes and retrieve the result synchronously:

auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
                  utility::conversions::to_string_t("YOUR_API_KEY"));

auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);

// Обязательные параметры позиционные; необязательные идут в структуре options
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");

// Вызов .get() для блокировки и получения результата синхронно
auto response = api.getComments(
    utility::conversions::to_string_t("your-tenant-id"),
    options
).get();  // Блокирует, пока HTTP‑запрос не завершится

if (response && response->comments) {
    std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}

Асинхронные вызовы с .then()

Use .then() for non-blocking asynchronous execution with callbacks:

auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
                  utility::conversions::to_string_t("YOUR_API_KEY"));

auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);

// Обязательные параметры позиционные; необязательные идут в структуре options
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");

// Используйте .then() для асинхронного выполнения с обратными вызовами
api.getComments(
    utility::conversions::to_string_t("your-tenant-id"),
    options
).then([](std::shared_ptr<GetComments_200_response> response) {
    // Этот код выполняется асинхронно после завершения запроса
    if (response && response->comments) {
        std::cout << "Found " << response->comments->size() << " comments" << std::endl;
    }
});

// Выполнение продолжается сразу же без блокировки
std::cout << "Request sent, continuing..." << std::endl;

Выбор между синхронным и асинхронным

The choice depends on your runtime environment and application architecture:

.get() (Синхронная блокировка)

• Блокирует вызывающий поток до завершения HTTP‑запроса
• Более простой поток кода, легче понимать
• Подходит для выделенных рабочих потоков, пакетной обработки или консольных утилит
• Не подходит для event‑loop’ов, GUI‑потоков или однопоточных серверов

.then() (Асинхронный без блокировки)

• Возвращает сразу, обратный вызов выполняется после завершения запроса
• Не блокирует вызывающий поток
• Требуется для событийно‑ориентированных архитектур, GUI‑приложений или однопоточных event‑loop’ов
• Позволяет цепочечное выполнение нескольких операций
• Более сложный контрольный поток

The SDK's test suite uses .get() exclusively, but this is appropriate for the test environment where blocking is acceptable.