API Traffic Requirements

Right now, Akita watches REST API traffic and processes a subset of all supported content types.

Our roadmap includes gRPC and GraphQL but we do not support those right now. Please get in touch if you're interested and we'll let you know when that's ready.

Supported Content Types

Akita currently supports the most popular API content types and we are working to add new content types. We welcome requests!

Supported Content-Types include:

  • application/json
  • application/x-www-form-urlencoded
  • application/octet-stream
  • text/plain
  • application/yaml
  • application/x-yaml
  • text/yaml
  • text/x-yaml

📘

Character Set Support

By default, Akita supports the UTF-8 and ASCII character sets. If your API is using a different character set (example: latin-1) you will need to specify it using the charset attribute in the Content-Type header.

🚧

Operating System Support

We do not yet have official Windows support for the Akita CLI. While our users have gotten Akita to work for the Windows Subsystem for Linux (WSL), it does not currently work to trace Windows APIs from a Docker container in WSL.

What Does Akita See?

You can use apidump to see what Akita can see. For instance, run the following cURL command against one of your API endpoints. This command will make a request to your API and return just the headers we need to determine compatibility.

curl -s -o /dev/null -D - https://app.akita.software

After successfully running the command above you should see output that looks something like the example below. To determine if your API is supported by Akita ensure the value in the Content-Type header is listed in the Supported Content Types table above. In this example, the Content-Type value is application/json which is supported by Akita.

HTTP/1.1 200 
Date: Tue, 14 Jul 2020 23:21:19 GMT
Content-Type: application/json; charset=utf-8

If you can't use apidump, don't worry! You can still generate HAR files from your browser or proxy tool.


Did this page help you?