cpp Rest API
Loading...
Searching...
No Matches
cpp_restapi::IConnection Struct Referenceabstract

Interface representing connection with rest api server. More...

#include <iconnection.hpp>

Inheritance diagram for cpp_restapi::IConnection:
cpp_restapi::BaseConnection cpp_restapi::CppHttplibBackend::Connection cpp_restapi::CurlBackend::Connection cpp_restapi::QtBackend::Connection

Public Member Functions

virtual ~IConnection ()=default
 
virtual std::string get (const std::string &request)=0
 perform a request to api
 
virtual const std::string & url () const =0
 return API url
 

Detailed Description

Interface representing connection with rest api server.

Constructor & Destructor Documentation

◆ ~IConnection()

virtual cpp_restapi::IConnection::~IConnection ( )
virtualdefault

Member Function Documentation

◆ get()

virtual std::string cpp_restapi::IConnection::get ( const std::string & request)
pure virtual

perform a request to api

Parameters
requestapi request. For example "users/SomeUserName/repos"
Returns
api response in json format

Implemented in cpp_restapi::BaseConnection.

◆ url()

virtual const std::string & cpp_restapi::IConnection::url ( ) const
pure virtual

return API url

Implemented in cpp_restapi::BaseConnection.


The documentation for this struct was generated from the following file: