Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elnormous/HTTPRequest

Single-header C++ HTTP request class
https://github.com/elnormous/HTTPRequest

Last synced: 6 days ago
JSON representation

Single-header C++ HTTP request class

Awesome Lists containing this project

README

        

# HTTPRequest

HTTPRequest is a single-header C++ library for making HTTP requests. You can just include it in your project and use it. HTTPRequest was tested on macOS, Windows, Haiku, BSD, and GNU/Linux, but it should work on most of the Linux-based platforms. Supports IPv4 and IPv6. HTTPRequest requires C++17 or newer.

## Usage

To use the library simply include `HTTPRequest.hpp` using `#include "HTTPRequest.hpp"`.

### Example of a GET request
```cpp
try
{
// you can pass http::InternetProtocol::V6 to Request to make an IPv6 request
http::Request request{"http://test.com/test"};

// send a get request
const auto response = request.send("GET");
std::cout << std::string{response.body.begin(), response.body.end()} << '\n'; // print the result
}
catch (const std::exception& e)
{
std::cerr << "Request failed, error: " << e.what() << '\n';
}
```

### Example of a POST request with form data
```cpp
try
{
http::Request request{"http://test.com/test"};
const string body = "foo=1&bar=baz";
const auto response = request.send("POST", body, {
{"Content-Type", "application/x-www-form-urlencoded"}
});
std::cout << std::string{response.body.begin(), response.body.end()} << '\n'; // print the result
}
catch (const std::exception& e)
{
std::cerr << "Request failed, error: " << e.what() << '\n';
}
```

### Example of a POST request with a JSON body
```cpp
try
{
http::Request request{"http://test.com/test"};
const std::string body = "{\"foo\": 1, \"bar\": \"baz\"}";
const auto response = request.send("POST", body, {
{"Content-Type", "application/json"}
});
std::cout << std::string{response.body.begin(), response.body.end()} << '\n'; // print the result
}
catch (const std::exception& e)
{
std::cerr << "Request failed, error: " << e.what() << '\n';
}
```

### Example of a GET request using Basic authorization
```cpp
try
{
http::Request request{"http://user:[email protected]/test"};
const auto response = request.send("GET");
std::cout << std::string{response.body.begin(), response.body.end()} << '\n'; // print the result
}
catch (const std::exception& e)
{
std::cerr << "Request failed, error: " << e.what() << '\n';
}
```

To set a timeout for HTTP requests, pass `std::chrono::duration` as a last parameter to `send()`. A negative duration (default) passed to `send()` disables timeout.

## License

HTTPRequest is released to the Public Domain.