SparkRegistry Extism Client Plugin

This project is an Extism plugin written in Go to interact with Sulu's registry of L402 APIs.

Prerequisites

Before using this plugin, ensure you have the following setup:

• Extism CLI and runtime installed and configured on your system. Visit Extism's official documentation for installation and setup instructions.
• TinyGo compiler for compiling Go to WebAssembly. Installation instructions can be found at TinyGo's site.

Installation

1. Clone the Plugin Repository

   Clone this repository to get the plugin source code:

   git clone https://github.com/sulusolutions/sparkregistry-extism-client
   cd sparkregistry-extism-client

2. Compile the Plugin

   Use the TinyGo compiler to build the WebAssembly module from the Go source code:

   tinygo build -o sparkregistry.wasm -target wasi main.go

   This command compiles the Go code in main.go to a WebAssembly module named sparkregistry.wasm.

Usage

To use the plugin with the Extism CLI, execute the following command:

extism call sparkregistry.wasm list --wasi --allow-host='*'

Functions

list()

The list() function provides a comprehensive overview of all available APIs within the service. Each API is described following the OpenAPI 3.0.0 specification, which includes detailed information about endpoints, security schemes, parameters, responses, and more.

Output Example

The output of the list() function is a JSON object with a single key apis, which is an array where each element represents an API described using the OpenAPI specification. Below is a summarized example of the response:

{
  "apis": [
    {
      "openapi": "3.0.0",
      "info": {
        "title": "Weatherman API",
         ...
        }
    },
    {
        ...
    }
    ...
  ]
}