SiddiqSoft.restcl 0.7.2

restcl : A focused REST Client for Modern C++

Objective

Design a library where JSON is a first-class API metaphor for interacting with RESTful servers.

• Focused on REST interactions with JSON. Limiting allows us to simplify the usage and make it feel very C++ instead of the C-like API of Win32 or OpenSSL.

• Modern C++ features: C++20 is required!

• Header only

• Use native implementations for the actual IO: Windows support uses WinHttp library.

  • Initial implementation is for Windows using WinHTTP.
  • Alternate implementation using OpenSSL tbd.

• Support for literals to allow _GET, _DELETE, etc.

• Support for std::format and concepts.

• Be instructional and use as little code as necessary.

• The focus is on the interface to the end user.

• Performance is not the objective.

• Simplicity (hide the underlying implementation)

    #include "siddiqsoft/restcl.hpp"
    #include "siddiqsoft/restcl_winhttp.hpp"
    ...
    using namespace siddiqsoft;
    using namespace siddiqsoft::literals;
  
    WinHttpRESTClient wrc("my-user-agent-string"); // optional UA; defaults to siddiqsoft.restcl/version
  
    // Create a simple GET request from the endpoint string
    // Send the request and invoke the callback.
    wrc.send( "https://google.com"_GET,
              [](const auto& req, const auto& resp) {
                 if(resp.success())
                    doSomething();
              });
     ...
     ...
    // Create a POST request by parsing out the string
    auto myPost= "https://server:999/path?q=hello-world"_POST;
    // Add custom header
    myPost["headers"]["X-MyHeader"]= "my-header-value";
    // Adds the content with supplied json object and sets the 
    // headers Content-Length and Content-Type
    myPost.setContent( {{"foo", "bar"}, {"goto", 99}} );
    // Send the request and invoke the callback
    wrc.send( std::move(myReq), [](auto& req, auto& resp){
                                   if(resp.success())
                                      doSomething();
                                   else
                                      logError(resp.error());
                                });
  

  API documentation