Display options
Layout, height, sections, endpoints, schemas, density and code languages: the options that control how Apifolio shows your API on the page.
Open the macro dialog (select the macro and click the pencil icon). The Display panel opens once a file is chosen, and the preview follows every change.
Layout
- Modern (3 panes): navigation on the left, documentation in the middle and code samples on the right. Best for most APIs.
- Classic (Swagger style): collapsible sections with coloured endpoint bars, familiar to anyone coming from Swagger UI. The data models are listed in a Schemas section at the bottom.
Height
- Fit content (page scrolls): the macro grows with its content.
- Compact (520 px), Standard (760 px), Tall (1000 px): the macro keeps a fixed height and scrolls inside.
The modern layout starts at Standard, the classic layout at Fit content. Readers can always open the reference full screen.
Show
- Introduction, Servers, Authentication and Schemas list: turn each part on or off.
- Hide deprecated endpoints.
- Hide webhooks: offered when the file has webhooks.
- Expand endpoints by default (classic layout): opens every endpoint bar when the macro shows 30 endpoints or fewer.
Only some endpoints
Large APIs are often easier to read in slices:
- Only these sections: pick one or more tags.
- Only these endpoints: filter the list and tick endpoints. They are saved by operation ID (or by method and path), so the choice survives new versions of the file. Endpoints that are no longer in the file are listed, so you can remove them.
- Only these paths: comma-separated paths with
*wildcards, for example/orders/*, /customers.
When the macro shows 1 to 3 picked endpoints, it becomes a compact endpoint card: no navigation, no overview and no search box, just the endpoints with their parameters, code samples and examples. Use it to embed one endpoint in a how-to guide.
With a section, endpoint or path filter, the schemas list and the model search show only the data models those endpoints use.
Where the filters apply:
- sections, endpoints, paths and Hide deprecated endpoints: the page, search in the macro, Copy for AI, Copy as Confluence content and PDF and Word exports;
- Hide webhooks: the page, search in the macro, Copy for AI and Copy as Confluence content.
Filters never change the file: ⋯ → Download still gives the whole spec.
Under the filters, the dialog shows how many of the shown endpoints Confluence search can find. See Confluence search.
More options
- Schema fields: how request, response and model schemas open. Collapsed (the default), First level open or All levels open (up to 3 levels deep). Readers can always use Expand all and Collapse all on any schema.
- Density: Comfortable (the default) or Compact, with tighter rows for long schemas and parameter lists.
- Code languages: which code sample tabs readers see, and in which order. The default is 8 tabs: cURL, JavaScript, Python, Go, Java, C#, PHP and Ruby. You can add PowerShell, cURL for the Windows command prompt, HTTPie, raw HTTP, Node (axios), Python (httpx), Kotlin, Swift and Rust, remove tabs and change their order. See Code samples.
Macros saved with Apifolio 2.0 keep their settings. The options added in 2.2 stay at their defaults until you change them.