Integration

SDKgen provides several ways to integrate our code generator into your project. The following page list all available integration options.

CLI

The SDKgen CLI is a simple binary written in go to access our generator. The following example show how you can use the binary.

> sdkgen install --client-id="[user]" --client-secret="[password]"

The install command reads the sdkgen.json file and automatically generates all defined dependencies.

GitHub

Docker

We provide the SDKgen CLI also as docker image in case you are not able to execute external binaries. In this case you only need to mount a specific volume and the generator will be executed within the docker image.

version: '3'
services:
  sdkgen:
    image: apiootech/sdkgen
    environment:
      SDKGEN_CLIENT_ID: "${SDKGEN_CLIENT_ID}"
      SDKGEN_CLIENT_SECRET: "${SDKGEN_CLIENT_SECRET}"
    volumes:
      - ./input:/usr/src/sdkgen/input
      - ./output:/usr/src/sdkgen/output

Docker Hub

GitHub Action

We also provide a GitHub action which you can easily integrate into your workflow to automatically generate code. The GitHub action also reads the sdkgen.json file and generates the defined dependencies.

version: '3'
name: SDKgen
on:
  - workflow_dispatch
jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: apioo/sdkgen-generator-action@v0.3.0
        with:
          client_id: '[SDKGEN_CLIENT_ID]'
          client_secret: '[SDKGEN_CLIENT_SECRET]'

GitHub Marketplace

REST API

It is also possible to manually integrate our code generator through the REST API.

Documentation