Once you generate an API model, there are many ways to explore it. In this guide, we'll show you how to:
- 👀 Browse your endpoints
- 🔎 Search and filter your endpoints
- 🙈 Hide fields from your model
- ✉️ Save and share
- 🚨 Having issues?
Akita lists each endpoint + operation, along with the number of trace events (request/response pairs), and the P99 latency for the events witnessed.
Each row expands to show the fields in the request and responses to this endpoint + operation, as well as the location and properties of the field—was it in the request or response; a header, cookie, body, etc.; and was the data in one or more data formats, like email, date/time, or phone numbers.
For even more details, you can show the OpenAPI3 spec for the endpoint by clicking "Show OpenAPI3 Spec".
You can use the search bar to do a keyword search over endpoints and fields. Enter one or more regular expressions, and endpoints (or fields) that don't match will be hidden.
Filters—shown on the left—count the number of endpoints with different properties, like the kind of authentication header present (if any), data formats present in the endpoint's requests/responses, response codes, and so on. Use the filters to drill down into your API. For example, you can use the "none" authentication filter to see all endpoints that do not use an authentication header.
Some fields—often headers—are present in every request or response. You can hide fields you're not interested in using the
Exclude filter. "Hidden" fields do not appear in an endpoint's list of fields, and any endpoints with no visible fields are also hidden.
Filters and search terms are reflected in the URL, so you will see the same filters and searches if you bookmark or copy and paste the URL. Members of your Akita team (see Managing Teams) can access any URLs you send them.
You can also download an OpenAPI3 spec from your API model using the "Download Spec" button at the top of the screen.
Finally, you can export the filtered list of endpoints as a JSON structure using the "Export as JSON" button. For example, you might use this to build a burn-down list of APIs without authentication headers to check as part of a security review.
Share your API model with us and let us know what's going wrong. We'll look into it straight away!
Updated about a month ago