codegen_define_ApiController_.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/codegen/codegen_define_ApiController_.hpp"

This file contains "defines" for ApiController code generating macro.
Usage:

#include OATPP_CODEGEN_BEGIN(ApiController)
...
// Generated Endpoints.
...
#include OATPP_CODEGEN_END(ApiController)

For details see:

ENDPOINT

Codegen macoro to be used in oatpp::web::server::api::ApiController to generate Endpoint.

#define ENDPOINT(METHOD, PATH, NAME, ...)

ENDPOINT_ASYNC

Codegen macoro to be used in oatpp::web::server::api::ApiController to generate Asynchronous Endpoint.

  • @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::Action.

#define ENDPOINT_ASYNC(METHOD, PATH, NAME)

ENDPOINT_ASYNC_INIT

Auxiliary codegen macro for ENDPOINT_ASYNC to generate correct constructor for Asynchronous Endpoint Coroutine. NAME - Name of the endpoint. Exact the same name as was passed to ENDPOINT_ASYNC macro.

#define ENDPOINT_ASYNC_INIT(NAME)