Back to docs
Design recipe
API reference page
A dense, scannable layout for documenting endpoints, parameters, schemas, and code samples. Built for developers who live in the reference.
Anatomy
Endpoint header
Method badge, path, short description. Sticky on scroll.
Parameter table
Name, type, required/optional, default, description. Sortable columns.
Request / response examples
Side-by-side code blocks with language tabs. Copy button per block.
Schema reference
Nested object viewer with expand/collapse. TypeScript-style annotations.
Visual rhythm
- Monospace for paths, types, and code. Inter for prose.
- Violet accents on interactive elements, pink on section headings.
- Dark cards with subtle borders group related content.
- Sticky sidebar with anchor-nav on desktop, collapsed on mobile.
States
Loading
Skeleton rows for parameter table. Pulsing code-block placeholders.
Empty
“No parameters” or “No request body” with contextual icon.
Error
Inline error banner if schema fetch fails. Retry link.
Responsive notes
- Sidebar collapses into a top accordion below 1024px.
- Parameter table scrolls horizontally on narrow viewports.
- Code blocks stack vertically instead of side-by-side.
- Sticky endpoint header remains fixed for quick context.