Where Observability
meets Structure

The only observability tool to build API behaviour models, Akita enables API-centric system monitoring and allows users to automatically detect breaking changes.

More about how Akita works

Try Akita with a Toy System

To help users get to know Akita better, we've built Akibox, a toy Dropbox-like file service. You can use it to try out Akita's spec generation to learn the Akibox API, and then make some changes to the Akibox code to see how Akita uses semantic diffing to highlight how code changes impact the API.

Step 1: Get Akibox and Fire It Up 🔥

# Clone the repo
git clone https://github.com/akitasoftware/akibox-tutorial.git
cd akibox-tutorial

# Create a python virtual environment and install dependencies
python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt

# Start the Akibox service
uvicorn main:app --reload

Step 2: Log into the Akita UI and Create an Akibox Service

Head over to the Akita UI, log in, and click "New Service" in the left menu.

Name it "akibox".

Step 3: Generate an API Model

Now that Akibox is running, set the Akita Client to start capturing packets in another window.

sudo akita learn --port 8000 --out akita://akibox:spec:AkiboxSpec

In a third window, run the akibox tests to generate some traffic to the service.

cd akibox-tutorial
./test.sh

Finally, head back to the window running the Akita Client (Shell 2), and hit ctrl-c to end packet capture. You should see a link printed in the CLI to see your fancy new API model.

Step 4: Get to Know Your API

Either grab the link from Step 3, or head over to the Akita UI, click "akibox" in the Services list in the left menu, and click the "AkiboxSpec" link.

At this point, you're ready to start exploring your API model.

Updated about a month ago



Try Akita with a Toy System


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.