Make sure to have Docker installed so you don't have to install the tooling for every API clients.

nvm use && yarn

You can also execute docker commands one by one, see Docker commands

yarn docker:setup

Build docker image from Dockerfile

How to add a new client | How to add a new language | Common Test Suite | Run the playground

yarn docker:build

Mount docker image on dev container

yarn docker:mount

Stops dev container and clean the built image

yarn docker:clean

You can make changes locally and run commands through the docker container.

yarn docker build specs <client | all>

yarn docker build specs

yarn docker build specs recommend

This is used by the build script and should not need to be called manually but if you want to format all specs file do:

yarn specs:fix

If you just want to check the format (not override the files), run:

yarn specs:lint <client> yarn specs:lint search

yarn docker generate <language | all> <client | all>

yarn docker generate

yarn docker build clients <language | all> <client | all>

yarn docker build clients java recommend

You can add -v to almost every command to have a more verbose output.

If you want to choose the language and client from a list you can add the --interactive option, or -i.

You can test our generated clients by running:

• The playground playground (Playground README)
• Tests with our Common Test Suite (CTS README).

Error: The operation couldn't be completed. Unable to locate a Java Runtime.

Java is not located in your PATH, either source the right .bash_profile, .zshrc, etc. file or do the following command in this repository:

echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile