Api Docs Page

A React API reference page with a sidebar nav, endpoints tagged by HTTP method, a copy base URL action and a curl request example in a code block.

src/registry/blocks/api-docs-page.tsx/r/api-docs-page.json

Installation#

bash
npx shadcn@latest add @minidev/api-docs-page

MiniDev UI is in the shadcn registry directory, so the short form works with no setup. Older CLI versions can use the full URL: npx shadcn@latest add https://ui.minidev.pro/r/api-docs-page.json

Usage#

tsx
import { ApiDocsPage } from "@/components/ui/api-docs-page"

export function Example() {
  return <ApiDocsPage />
}

API reference#

ApiDocsPage takes no props. It ships with realistic sample content: install it, then edit the copy and data in the file directly. The file is yours.

Dependencies#

npm

React only
All Developer tool UI components for React