FAQs

When running Akita to watch traffic going to an API I run, I need to specify the port my service runs on for best results. What if I don't know what part my service uses?

I know I'm running the service I want to model in a Docker container, but I don't know its name. How do I go about finding out the name?

When viewing your spec, you might notice endpoints like `GET /users/foo`, where you know that `foo` is really a path variable. Akita can generally infer path variables if given enough examples of the API calls. If an API endpoint is missing path variables, make sure Akita is able to observe at least 2 successful calls to the endpoint using different values for the variable. For example, if Akita observes: ``` GET /users/foo GET /users/bar ``` then Akita can correctly infer the path variable and generalize the path as `GET /users/<arg2>`.

Help! The Akita Client captures extra traffic (from images, font families, and more) on my network and it shows up in my spec. How do I tell Akita I don't care about these endpoints?

This depends on the size of your API and the amount of traffic SuperLearn can observe. If your API is broad, with infrequently-used endpoints, then we'll need to watch more traffic.

The generated API spec is as complete as the observed traffic. SuperLearn generates API specs from every endpoint that it sees. 👀 You can also add additional endpoints manually via the Akita Console.

The Akita Console allows you to review, edit, and approve changes to the generated API specification. You can use the Akita Console to make changes to the generated API specification at any time.