namespace
#include <include/reqboost/Api.h>
Api
Functions
-
auto request(const std::string& method,
const std::string& url,
const py::kwargs kwargs) -> Models::
Response - Makes a generic HTTP request.
-
auto get(const std::string& url,
const py::dict params = py::none(),
py::kwargs kwargs = {}) -> Models::
Response - Makes a GET request to the specified URL.
-
auto post(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {}) -> Models::
Response - Makes a POST request to the specified URL.
-
auto put(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {}) -> Models::
Response - Makes a PUT request to the specified URL.
-
auto delete_(const std::string& url,
py::kwargs kwargs = {}) -> Models::
Response - Makes a DELETE request to the specified URL.
-
auto head(const std::string& url,
py::kwargs kwargs = {}) -> Models::
Response - Makes a HEAD request to the specified URL.
-
auto patch(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {}) -> Models::
Response - Makes a PATCH request to the specified URL.
-
auto options(const std::string& url,
py::kwargs kwargs = {}) -> Models::
Response - Makes an OPTIONS request to the specified URL.
Function documentation
Models:: Response Reqboost:: Api:: request(const std::string& method,
const std::string& url,
const py::kwargs kwargs)
Makes a generic HTTP request.
Parameters | |
---|---|
method | The HTTP method to use for the request. |
url | The URL to send the request to. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes an HTTP request using the specified method and URL. It can also accept optional parameters and keyword arguments.
Models:: Response Reqboost:: Api:: get(const std::string& url,
const py::dict params = py::none(),
py::kwargs kwargs = {})
Makes a GET request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
params | Optional parameters for the request. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a GET request to the specified URL. It can also accept optional parameters and keyword arguments.
Models:: Response Reqboost:: Api:: post(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {})
Makes a POST request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
data | Optional data for the request. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a POST request to the specified URL. It can also accept optional data and keyword arguments.
Models:: Response Reqboost:: Api:: put(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {})
Makes a PUT request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
data | Optional data for the request. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a PUT request to the specified URL. It can also accept optional data and keyword arguments.
Models:: Response Reqboost:: Api:: delete_(const std::string& url,
py::kwargs kwargs = {})
Makes a DELETE request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a DELETE request to the specified URL. It can also accept optional parameters and keyword arguments.
Models:: Response Reqboost:: Api:: head(const std::string& url,
py::kwargs kwargs = {})
Makes a HEAD request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a HEAD request to the specified URL. It can also accept optional parameters and keyword arguments.
Models:: Response Reqboost:: Api:: patch(const std::string& url,
const py::dict data = py::none(),
py::kwargs kwargs = {})
Makes a PATCH request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
data | Optional data for the request. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes a PATCH request to the specified URL. It can also accept optional data and keyword arguments.
Models:: Response Reqboost:: Api:: options(const std::string& url,
py::kwargs kwargs = {})
Makes an OPTIONS request to the specified URL.
Parameters | |
---|---|
url | The URL to send the request to. |
kwargs | Optional keyword arguments for the request. |
Returns | A Reqboost:: |
This function makes an OPTIONS request to the specified URL. It can also accept optional parameters and keyword arguments.