SDKgen provides several ways to integrate our code generator into your project. The following page list all available integration options.
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. You can also run the command without client id or secret but this has a stricter rate limit.
GitHubThe sandbox is an Angular app which allows to design a schema in the browser. Every schema is stored locally in the browser. It also integrates with our generator API so you can directly convert your schema into code.
WebsiteThe electron app basically wraps the sandbox app in electron so that you can run the app as desktop app. This also allows you to directly write the generated code to your filesystem.
GitHubWe 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
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]'
It is also possible to manually integrate our code generator through the REST API.
Documentation