Bookkeeping C++ API client V0.0.1

Manual setup

Fedora

Install dependencies and build the C++ client. In the root directory of the client:

dnf install cpprest-devel boost-devel openssl-devel 
mkdir build; cd build
cmake -DCPPREST_ROOT=/usr/include/cpprest ..

Centos 7

Install and build cpprestdk:

git clone git@github.com:microsoft/cpprestsdk.git
cd cpprestsdk
git submodule update --init
mkdir build; cd build
cmake .. -DCMAKE_INSTALL_PREFIX=~/cpprestsdk_install

Cmake and make the C++ client. In the root directory of the client:

cmake . -DCPPREST_LIB=~/cpprestsdk_install -DCPPREST_ROOT=~/cpprestsdk_install
make

Alternatively, you can speed up the build by adding the amount of cores it may run on:

make -j $(expr $(nproc) - 1)

Usage

This library serves as an C++ API client to the O2 bookkeeping system. API endpoints are documented in docblocks in BookkeepingInterface.h, or in the documentation directory -> index.html -> Bookkeeping -> BookkeepingApi. There's also an example of the usage in Example.cpp

API token TODO: Create API endpoint to fetch token? -> ask cern

API token is loaded into the Bookkeeping request upon page load, and can be extracted by looking with the chrome inspector -> network -> reload page and fetch token from request.

Example code

If your api is at http://localhost:4000/api:

export BOOKKEEPING_URL=http://localhost:4000/api
export BOOKKEEPING_API_TOKEN=jnk5vh43785ycj4gdvlvm84fg...
./bookkeeping-api-cpp-example 1  # argument is run number to add

Note: don't include the "Bearer " part of the token, it's added automatically.

Generate API client

Generate the API client based on the OpenApi file. For generating the sourcecode we use an openapi-generator.

To use the stripped down version of the generator exectue the following command in the root directory of the api client:

Mac/Linux:

wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/5.0.0-beta2/openapi-generator-cli-5.0.0-beta2.jar -O openapi-generator-cli.jar

Windows:

For Windows users, you will need to install wget or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.

Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/5.0.0-beta2/openapi-generator-cli-5.0.0-beta2.jar

Usage

Once the jar is downloaded, generate the api client with the following command. Please check that the paths are valid before doing so.

java -jar openapi-generator-cli.jar generate -i openapi-source.yaml -g cpp-restsdk -o src/cpprest-client