Skip to content

docs: Add EndpointRequestSnippet to runnable endpoint docs #3312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Add EndpointRequestSnippet to runnable endpoint docs #3312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .../products/docs/pages/component-library/default-components/runnable-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ description: Add testable API endpoints to your docs with RunnableEndpoint. Supp

The `<RunnableEndpoint>` component lets users make real HTTP requests to your APIs directly in the API Reference. It auto-detects endpoint definitions from your API specification and provides a request builder with inputs for headers, path parameters, query parameters, and request bodies.

<EndpointRequestSnippet />


## Usage

<div className="highlight-frame">
Expand All @@ -18,6 +21,7 @@ The `<RunnableEndpoint>` component lets users make real HTTP requests to your AP
## Features

The component supports:

- **Multiple examples** – When your endpoint has multiple pre-configured examples, the component displays a dropdown selector in the header so users can switch between different examples
- **Multiple environments** – If your API defines multiple environments (production, staging, development), the component automatically displays an environment selector so users can test against different base URLs
- **API Reference integration** – Each `<RunnableEndpoint>` includes a button that links users to the full API Reference documentation for the endpoint
Expand Down