microcks-import-artifacts

Microcks Import Artifacts

Import OpenAPI specifications into Microcks and automatically configure dispatchers based on vendor extensions.

When to Use This Skill

Use this skill when:

• Importing an OpenAPI spec into a running Microcks instance for mocking
• Auto-configuring dispatchers after writing a spec with x-mocking-microcks-dispatcher extensions
• Setting up a repeatable import workflow with shell scripts

Prerequisites

• Docker installed and running
• Microcks started (use the microcks-local-server skill)
• jq installed (brew install jq / apt install jq)
• curl installed

Quick Start

IMPORTANT: The import and dispatcher configuration MUST be done by running the import-openapi.sh shell script. Do NOT attempt to configure dispatchers manually via curl or the Microcks API — the script handles the full workflow (import, discriminant detection, Groovy script loading, API calls).

1. Create the mocking/ directory structure:

mkdir -p mocking/dispatchers

1. Copy the template scripts into it:

cp templates/import-openapi.sh mocking/import-openapi.sh
cp templates/download-microcks-cli.sh mocking/download-microcks-cli.sh
chmod +x mocking/import-openapi.sh mocking/download-microcks-cli.sh

1. Run the import script (this is the only command needed to import AND configure dispatchers):

./mocking/import-openapi.sh path/to/your-api-spec.yaml

The script will:

• Check that Microcks is running
• Download microcks-cli if not already cached
• Import the spec into Microcks
• Read x-mocking-microcks-dispatcher vendor extensions
• Auto-configure dispatchers via the Microcks API

Security Notice

This skill provides shell script templates that the user copies into their project. These scripts:

• Download an external binary (microcks-cli from GitHub releases of microcks/microcks-cli)
• Run Docker containers (mikefarah/yq for YAML-to-JSON conversion, from mikefarah/yq)
• Make network calls to the local Microcks REST API