The API provides endpoints for Visual Keys NFT collection and token metadata, as well as on-the-fly image generation.
It serves metadata and images for NFT marketplaces.

• Query NFT collection metadata
• Query NFT token metadata
• Generate on-the-fly SVG/PNG images for NFTs

You can build and run the API using Java, Docker, or as a native executable.

Prerequisites:

• Java 23+

Steps:

./gradlew runFatJar

1. Build the JAR:

   ./gradlew buildFatJar

2. Build the Docker image:

   docker build -t visualkey-api .

3. Run the Docker container:

   docker run -p 8080:8080 visualkey-api

Prerequisites:

• GraalVM JDK 24 with Native Image

Steps:

./gradlew nativeCompile ./build/native/nativeCompile/api

1. Build the native image:

   ./gradlew nativeCompile

2. Build the Docker image:

   docker build -f Dockerfile-native -t visualkey-api-native .

3. Run the Docker container:

   docker run -p 8080:8080 visualkey-api-native

Example:

docker run -e HTTP_PORT=80 -p 80:80 visualkey-api

The API is documented in OpenAPI format.

When running locally, interactive API documentation is also available at the /swagger endpoint.

MIT