Ship Faster with Confidence.

Designed for any developer or SRE, Akita uses eBPF and state-of-the-art API traffic modeling algorithms to power a drop-in solution for understanding and monitoring API behavior.

More about how Akita works

Watch API Traffic

To run Akita, you first collect API traffic and then upload the traffic to the Akita cloud for learning and analyzing API models. There are a few ways to collect API traffic.

  • Using Akita to watch API traffic to a server. If you own/run the service you want to generate an Akita API model for, then you should run Akita as an agent to passively watch traffic going to your service. Akita will help you generate a HAR file that the CLI will use for generating specs. You can generate a HAR file and send it up to Akita by using the learn command:
akita learn --service {service name} --port {port}
sudo akita learn --service {service name} \
    --interface {network interface} \
    --port {port}
docker pull akitasoftware/cli:<<current_cli_version>> && docker run --rm -it \
  --env AKITA_API_KEY_ID=${KEY_ID} \
  --env AKITA_API_KEY_SECRET=${KEY_SECRET} \
  --net={network} akitasoftware/cli:<<current_cli_version>> learn \
  --service {service name} \
  --port {port}

Using learn is the equivalent of using apidump and apispec in sequence.

  • Using a browser to generate a HAR file. If you would like to generate a spec for any AJAX website, you can use a common web browser to generate a HAR file.

  • Using a proxy to generate a HAR file. If you would like to generate a spec for a third-party service, you can use a proxy (for instance, the Charles proxy) to generate a HAR file.

Akita also has solutions for integrating with test frameworks where there are non-network tests, as well as solutions for integrating Akita in staging and production.

Updated 2 months ago


What's Next

To integrate Akita more deeply in your systems, read on to learn how to run Akita in CI/CD, run Akita with non-network tests, and run akita in staging and production.

Run Akita on Every Pull Request
Watch API Traffic to Non-Network Tests
Run Akita in Staging and Production

Watch API Traffic


Suggested Edits are limited on API Reference Pages

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