MADANA-IO / madana-apiclient-cpp

C++ JSON client-side library that defines the C++classes that can be (de)serialized to/from JSON. This is useful for accessing the REST endpoints that are published by the madana-api, but only those that produce a JSON representation of their resources (content type "application/json").

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

C++ API client

Using the madana-api

This documentation contains a Quickstart Guide, relating client functionality and information about the available endpoints and used datamodels.

The madana-api and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. We take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away! If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to info@madana.io. Please DO NOT file a public issue. If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly


Note: Not all functionality might be acessible without having accquired and api-license token. For more information visit www.madana.io


Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

  • API version: 0.5.0-master.56

  • Package version:

  • Build package: org.openapitools.codegen.languages.CppRestSdkClientCodegen

  • API namespace: com.madana.apiclient.api

  • Model namespace: com.madana.apiclient.model

Installation

Prerequisites

Install cpprestsdk.

  • Windows: vcpkg install cpprestsdk cpprestsdk:x64-windows boost-uuid boost-uuid:x64-windows
  • Mac: brew install cpprestsdk
  • Linux: sudo apt-get install libcpprest-dev

Build

cmake -DCPPREST_ROOT=/usr -DCMAKE_CXX_FLAGS="-I/usr/local/opt/openssl/include" -DCMAKE_MODULE_LINKER_FLAGS="-L/usr/local/opt/openssl/lib"
make

Build on Windows with Visual Studio (VS2017)

  • Right click on folder containing source code
  • Select 'Open in visual studio'
  • Once visual studio opens, CMake should show up in top menu bar.
  • Select CMake > Build All.

*Note: If the CMake menu item doesn't show up in Visual Studio, CMake for Visual Studio must be installed. In this case, open the 'Visual Studio Installer' application. Select 'modify' Visual Studio 2017. Make sure 'Desktop Development with C++' is installed, and specifically that 'Visual C++ tools for CMake' is selected in the 'Installation Details' section.

Also be sure to review the CMakeLists.txt file. Edits are likely required.*

Author

About

C++ JSON client-side library that defines the C++classes that can be (de)serialized to/from JSON. This is useful for accessing the REST endpoints that are published by the madana-api, but only those that produce a JSON representation of their resources (content type "application/json").


Languages

Language:C++ 99.8%Language:CMake 0.2%