Generate SDK

It's time to generate an SDK to use Arbitrium as a library in your code. With Arbitrium, we decide to use Swagger. With Swagger, it's easy to generate an Arbritium SDK for any developer that might need it. Let's have a quick tutorial showing you how to generate an SDK.

Using our dashboard#

Go on our dashboard#

Go on our dashboard and click on SDK.

Choose your language and download your kit#

You can choose your language client-side and download it. The zip file will contain all the necessary code files.

Using Swagger editor#

Get Arbitrium's OpenAPI specification#

Go on our API's page and click on Download right next to Download OpenAPI specification:

Swagger editor#

Now, go to Swagger editor and copy/paste the OpenAPI specification. You should see our API on the right side of the page.

Generate an SDK#

Now, we can generate an SDK. Click on Generate Client

Select your programming language and use it!

How to use it#

Go#

Create a folder named Swagger in your Go project and copy the generated SDK inside it. Your project structure should look like this.

You will need to add a dependency. You can do it by running this command.

go get golang.org/x/oauth2

You will need a swagger configuration and an auth context to use the SDK.

Here's an example of a deployment

// Creating Arbitrium deploy request
payload := swagger.DeployModel{
    AppName:     appName, // Your application's name
    VersionName: appVersion, // Your version's name
    IpList:      ips, // A list of users IP
}

// API configuration
configuration := swagger.NewConfiguration()
configuration.BasePath = arbitriumAPI // The API base URL

// Creating a client
client := swagger.NewAPIClient(configuration)

// Auth context
auth := context.WithValue(context.Background(), swagger.ContextAPIKey, swagger.APIKey{
    Key:    apiToken, // Your Arbitrium token
    Prefix: "token",
})

// Deploying
request, _, err := client.V1Api.Deploy(auth, payload)

if err != nil {
    log.Printf("Could not deploy game server, err: %v", err.Error())
    return "", err
}