konfig.yaml

konfig.yaml is a required configuration file that tells konfig CLI how to operate. Explore the schema here.

Example

Here is an example konfig.yaml that contains configuration to generate SDKs for many languages.

_74

outputDirectory: /tmp/acme-sdks-out

_74

specPath: api.yaml

_74

generators:

_74

java:

_74

version: 1.0.0

_74

groupId: com.acme

_74

artifactId: acme-java-sdk

_74

outputDirectory: java

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/java

_74

python:

_74

version: 1.0.0

_74

packageName: acme_client

_74

projectName: acme-python-sdk

_74

outputDirectory: python

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/python

_74

typescript:

_74

version: 1.0.0

_74

npmName: acme-typescript-sdk

_74

outputDirectory: typescript

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/typescript

_74

csharp:

_74

version: 1.0.0

_74

packageName: Acme.Net

_74

logoPath: logo.png

_74

outputDirectory: csharp

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/csharp

_74

swift:

_74

version: 1.0.0

_74

projectName: Acme

_74

podAuthors: acme.com

_74

outputDirectory: swift

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/swift

_74

objc:

_74

version: 1.0.0

_74

podName: AcmeClient

_74

authorName: acme.com

_74

authorEmail: engineering@acme.com

_74

classPrefix: A

_74

outputDirectory: objc

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/objc

_74

kotlin:

_74

version: 1.0.0

_74

groupId: com.acme

_74

artifactId: acme-kotlin-sdk

_74

outputDirectory: kotlin

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/kotlin

_74

go:

_74

version: 1.0.0

_74

packageName: acme

_74

outputDirectory: go

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/go

_74

php:

_74

version: 1.0.0

_74

packageName: acme-php

_74

outputDirectory: php

_74

git:

_74

userId: konfig-dev

_74

repoId: acme-sdks/tree/main/php