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: Log into the Akita UI and Create an Akibox Service

Head over to the Akita UI, log in, click "Settings" in the left menu, and go to the "Services" tab.

Enter "akibox" in the "Service Name" field and click the "Create Service" button.

Step 2: 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 3: Generate an API Model

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

sudo akita apidump --filter "port 8000" --service akibox

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

cd akibox-tutorial
for i in {1..180}; do
  ./test.sh
  sleep 1
done

Let it run for a few minutes to build up some traffic, and then head over to the Akita UI and select "akibox" in the Services dropdown at the top of the page.

Akita can take up 2-5 minutes to process your initial traffic. Once it does, visit the API Model page to check out the API model and the Metrics & Errors page to see per-endpoint traffic metrics, including volume, latency, and errors.


What’s Next

Next, deploy Akita to monitor your system. The first step is determining where to run the Akita Client to capture network traffic to your services.

Did this page help you?