Navigation and search
Find any endpoint, field or data model fast: a navigation tree with nested tags, search that understands pasted URLs, typos and field names, and keyboard shortcuts.
Navigation
In the modern layout, the left pane is a tree:
- Overview: the description, servers, authentication methods and the sections of the API.
- The sections (tags), grouped by
x-tagGroupswhen the spec uses them. OpenAPI 3.2 tagparenthierarchies nest to any depth. Specs without tags are grouped by path. - The endpoints of each section.
- Schemas: every data model, with a filter box.
The tree works with the keyboard: the arrow keys move, Right and Left open and close a section, Home and End jump to the first and last row, Enter opens the page, and typing a letter moves to the next row that starts with it.
In the classic layout, each section is a collapsible block. Nested sections are indented and show their parent sections before their name.
Links in descriptions written for Redoc or Swagger UI, such as #operation/createPet, #/components/schemas/Pet or #operations-pets-createPet, open the right endpoint or data model. Response links that point to another endpoint of the file open it too.
Search
The search box at the top finds endpoints by method, path, summary, operation ID, tag, parameter name and the start of the description, and lists the matching data models. Click a model to open it.
Search also understands what developers paste and type:
- URLs: paste
POST https://api.example.com/v2/payments/pay_123/capturefrom a log or a terminal and it findsPOST /payments/{payment_id}/capture. The method is optional, and the server address and the query string are ignored. - Typos:
refndfinds the refund endpoints and says "Showing results for refund". - Field names:
payment_methodfinds the endpoints whose request body or successful response has a field with that name (up to 3 levels deep), and says which field matched.
Results are ranked, so an exact operation ID or summary comes first and field-name matches come last. Use ↑ and ↓ to move through the results and Enter to open one. Screen readers hear how many results there are.
Keyboard shortcuts
| Shortcut | Action |
|---|---|
/ |
Focus the search box (when you are not typing in a field) |
Ctrl + K or ⌘ + K |
Focus the search box |
Ctrl + F or ⌘ + F |
Focus the search box (when the macro has focus) |
↑ and ↓, then Enter |
Move through the search results and open one |
Esc |
Clear the search |
| Arrow keys | Move in the navigation tree and between tabs, such as the code languages |
Ctrl + F opens Apifolio's search instead of the browser's, because the browser can't see endpoints that are not on screen yet.
Schemas and variants
Request bodies, responses and data models show their fields as a tree. Expand all and Collapse all open or close a whole schema (up to 3 levels deep).
When a body can take several shapes (oneOf, anyOf, or subtypes that extend a base schema with a discriminator), each shape is a pill above the fields. Pick one to see its fields: the example next to the schema and the code samples switch to that shape. Choosing another example moves the pill to the shape it matches.
Full screen
Click the expand icon at the top right to read the API full screen. Close it with the close icon.