# ApiClient_define.hpp
This File On Github
Ask A Question
API: latest
module: oatpp
#include "oatpp/codegen/ApiClient_define.hpp"
This file contains "defines" for ApiClient code generating macro.
Usage:
#include OATPP_CODEGEN_BEGIN(ApiClient)
...
// Generated API-Calls.
...
#include OATPP_CODEGEN_END(ApiClient)
For details see:
# API_CLIENT_INIT
Codegen macoro to be used in classes extending oatpp::web::client::ApiClient to generate required fields/methods/constructors for ApiClient.
- @param NAME - name of the ApiClient class.
#define API_CLIENT_INIT(NAME)
# API_CALL
Codegen macoro to be used in oatpp::web::client::ApiClient
to generate REST API-Calls.
- @param METHOD - Http method ("GET", "POST", "PUT", etc.)
- @param PATH - Path to endpoint (without host)
- @param NAME - Name of the generated method
- @return - std::shared_ptr to oatpp::web::protocol::http::incoming::Response
#define API_CALL(METHOD, PATH, ...)
# API_CALL_ASYNC
Codegen macro to be used in oatpp::web::client::ApiClient
to generate Asynchronous REST API-Calls.
- @param METHOD - Http method ("GET", "POST", "PUT", etc.)
- @param PATH - Path to endpoint (without host)
- @param NAME - Name of the generated method
- @return - oatpp::async::CoroutineStarterForResult<const std::shared_ptr<oatpp::web::protocol::http::incoming::Response>>.
#define API_CALL_ASYNC(METHOD, PATH, ...)
# API_CALL_HEADERS
Codegen macro to add default headers to API_CALL
#define API_CALL_HEADERS(NAME)