Zum Inhalt springen

Template

API Docs Page

API documentation layout with endpoint list, request/response panels, auth policy, and copy-ready examples.

Structure

Type: api_docs

Regions: 3

Components: 5

Status: active

Exports: json, html-css, react-tailwind, markdown, design-spec-json, report

Responsive defaults

  • Endpoint navigation · 3 cols · stackBelow 940
  • API content · 6 cols · stackBelow 720
  • Examples rail · 3 cols · stackBelow 1080

Accessibility notes

  • Includes a heading and main region for deterministic semantic checks.
  • Interactive controls are sized for at least 44px tap targets where applicable.
  • Image and form components carry metadata for alt text and labels when present.

Responsive notes

  • Configured for narrow, mobile, tablet, desktop, and wide viewport checks.
  • Regions include stackBelow hints so rails and dense panels collapse before overflow.
  • Exports preserve semantic region and component markers for downstream review.