Get Started with Akita

Welcome to the Akita Software developer hub. You'll find comprehensive guides and documentation to help you start working with Akita Software as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Where Observability Meets Structure

Visualize, Map, and Manage Every Relationship Across your Service Ecosystem.

How do you know if a small code change can take down your site? At Akita, we're building tools to help you answer that question.

Akita watches calls to web APIs in order to build structured models of API behavior. Akita uses these models to help you catch breaking changes on every pull request, discover how real API traffic compares to expectations, and give you up-to-date specs for your services. You can install the Akita agent in minutes, with no code changes or proxies necessary.

Watch a video of our demo at the NY Enterprise Tech Meetup here.

Using Akita

Watch Traffic

Akita works by capturing calls to web APIs in order to build models of API behavior.

  • For a service you own. Our low-footprint agent uses pcap filters to monitor API traffic to your service. Just tell Akita where to watch and we'll take care of the rest.
  • For a service you want to watch traffic to. You can use a web browser, off-the-shelf proxy tool, and more to watch traffic going to a service of interest. As long as you can capture an HTTP Archive (HAR) file, Akita can work with the output.
  • For integration tests that don't generate network traffic. Akita integrates with a number of test frameworks including Flask and FastAPI to capture mock API traffic.

Build API Models

Akita analyzes API traffic to understand:

  • What endpoints are in the traffic?
  • What data types and data formats is Akita seeing?
  • 🚧 Coming soon: what implicit contracts does Akita detect in the API calls?

Get Reports

From Akita API models, you can get:

  • Automatically generated API specs, with inference for path arguments, types, and data formats
  • Reports on every pull request about what endpoints, types, data formats, and more have change

Keep Your Data Secure

Our client only sends back request and response metadata to the Akita cloud, meaning Akita never sees potentially sensitive data in your requests and responses.

Getting Started with Akita

  1. Follow this tutorial to use Akita with the Akibox demo service.
  2. Follow this Quick Start to use Akita to model AJAX APIs from the browser. This technique also works if you are using a standard proxy tool, for instead the Charles Proxy.
  3. Follow this Quick Start to use the Akita agent to model traffic going to one of your services. Note that you can also generate traffic to a service by using Postman Collections.
  4. Learn about how to Integrate with Integration Tests.
  5. Learn about how to use a Proxy for Encrypted Traffic.

Updated 12 days ago

Where Observability Meets Structure

Visualize, Map, and Manage Every Relationship Across your Service Ecosystem.

Suggested Edits are limited on API Reference Pages

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