• Java 11+.
• Build time with tests: Docker or an equivalent container engine. This is for running tests with testcontainers). Naturally, if you're using an Apiman container, you'll need it for runtime too!

You can look at the Apiman quickstarts on apiman.io.

Or, you can build and run our 'server-all' quickstart to try everything out immediately.

Here's what you need to do:

echo "Building Apiman"
./fastbuild.sh

echo "Starting a Keycloak container with a demo Apiman realm"
cd tools/server-all/target/docker
docker compose up -d

echo "Starting Apiman"
cd ../
./wildfly-dev-server/bin/standalone.sh

Once Apiman has started up, and if all went well, you can point your browser to the API Manager via http://localhost:8080/apimanui/ and log in (either register a new user or log in as the admin):

• Username: admin
• Password: admin123!

You can log into the Keycloak admin console via http://localhost:8081/admin (same credentials as above).

This quickstart seeds a bunch of content into apiman. This is not strictly necessary, but it does populate the API Manager with some data so that it doesn't feel so lonely the first time you log in.

You're welcome. Please don't use default users and passwords in production.

The easiest way to build quickly (without tests) is to run our fastbuild script. It's in the root of the project. If you have mvnd the build will be faster.

./fastbuild.sh 

First, build the parent pom (it's in /parent), then you can build the main project from the top level.

echo "Building Apiman Parent..."
cd parent
../mvnw clean install

cd ..
echo "Building the main Apiman project..."
./mvnw clean install

Apiman is open source, and we welcome anybody who wants to participate and contribute!

If you want to fix a bug or make any changes, please log an issue in GitHub Issues describing the bug or new feature.

You can also join our discussion forums if you want help, or to discuss a more complex issue.

There are lots of different workflows for contributing. Feel free to use one that suits you. We're endeavouring to pull together a more detailed contribution document that we'll upload soon 🙌.

Apiman also comes with a developer portal. There you can allow developers to access your APIs. Developers can view and test your APIs to develop their own apps.
Check it out here: Apiman Developer-Portal

Apiman is a non-commercial project and it is supported downstream by multiple commercial sponsors that offer support and SaaS.

Scheer PAS is the platform for flexible end-to-end support of individual processes. It stands for digitization and automation, regardless of how many people, systems or companies need to be integrated.

Scheer PAS API Management is based on Apiman and offers you also enterprise support.
You may visit Scheer PAS documentation for further details.