README.md•4.38 kB
# C++ Qt API client
# cpp-client
GameBrain API
- API version: 1.0.1
- Generator version: 7.8.0-SNAPSHOT
GameBrain API
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
## Requirements
Building the API client library requires:
1. CMake 3.2+
2. Qt
3. C++ Compiler
## Getting Started
example.h:
```c++
#include <iostream>
#include "../client/OAIDefaultApi.h"
using namespace test_namespace;
class Example : public QObject {
Q_OBJECT
qint32 create();
QString create();
public Q_SLOTS:
void exampleFunction1();
};
```
example.cpp:
```c++
#include "../client/OAIDefaultApi.h"
#include "example.h"
#include <QTimer>
#include <QEventLoop>
qint32 Example::create(){
qint32 obj;
QString Example::create(){
QString obj;
return obj;
}
void Example::exampleFunction1(){
OAIDefaultApi apiInstance;
// Configure API key authorization: apiKey
apiInstance.setApiKey("YOUR API KEY NAME","YOUR API KEY");
// Configure API key authorization: headerApiKey
apiInstance.setApiKey("YOUR API KEY NAME","YOUR API KEY");
QEventLoop loop;
connect(&apiInstance, &OAIDefaultApi::detailSignal, [&]() {
loop.quit();
});
connect(&apiInstance, &OAIDefaultApi::detailSignalE, [&](QNetworkReply::NetworkError, QString error_str) {
qDebug() << "Error happened while issuing request : " << error_str;
loop.quit();
});
qint32 id = create(); // qint32 | The unique identifier of the game.
QEventLoop loop;
connect(&apiInstance, &OAIDefaultApi::detailSignal, [&]() {
loop.quit();
});
connect(&apiInstance, &OAIDefaultApi::detailSignalE, [&](QNetworkReply::NetworkError, QString error_str) {
qDebug() << "Error happened while issuing request : " << error_str;
loop.quit();
});
QString api_key = create(); // QString | Your API key for authentication.
apiInstance.detail(idapi_key);
QTimer::singleShot(5000, &loop, &QEventLoop::quit);
loop.exec();
}
```
## Documentation for Servers
Parameterized Servers are supported. Define a server in the API for each endpoint with arbitrary numbers of variables:
```yaml
servers:
- url: http://{server}:{port}/{basePath}
description: Description of the Server
variables:
server:
enum:
- 'petstore'
- 'qa-petstore'
- 'dev-petstore'
default: 'petstore'
port:
enum:
- '3000'
- '1000'
default: '3000'
basePath:
default: v1
```
To change the default variable, use this function in each Api:
```c++
int setDefaultServerValue(int serverIndex,const QString &operation, const QString &variable,const QString &val);
```
The parameter "serverIndex" will choose a server from the server list for each endpoint. There is always at least one server with index 0. The Parameter "operation" should be the desired endpoint operationid.
Variable is the name of the variable you wish to change and the value is the new default Value.
The function will return -1 when the variable does not exists, -2 if value is not defined in the variable enum and -3 if the operation is not found.
If your endpoint has multiple server objects in the servers array, you can set the server that will be used with this function:
```c++
void setServerIndex(const QString &operation, int serverIndex);
```
Parameter "operation" should be your operationid. "serverIndex" is the index you want to set as your default server. The function will check if there is a server with your index.
Here is an example of multiple servers in the servers array. The first server will have index 0 and the second will have index 1.
```yaml
servers:
- url: http://{server}:8080/
description: Description of the Server
variables:
server:
enum:
- 'petstore'
- 'qa-petstore'
- 'dev-petstore'
default: 'petstore'
- url: https://localhost:8080/v1
```
## Documentation for Authorization
Authentication schemes defined for the API:
### apiKey
- **Type**: API key
- **API key parameter name**: api-key
- **Location**: URL query string
### headerApiKey
- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header
## Author
mail@gamebrain.co
## License
for more information visit []()