Changelog

HTTP Snippets now enabled by default

HTTP snippets are now enabled by default for all documentation sites, making it easier for developers to see cURL, Python, Ruby, and other HTTP client examples directly in your API reference. Previously, this feature required internal configuration to activate.

You can now control HTTP snippets directly in your docs.yml file:

1
# Turn off HTTP snippets
2
settings:
3
  http-snippets: false
4
5
# Or specify only certain languages
6
settings:
7
  http-snippets:
8
    - python
9
    - ruby

Visit the HTTP snippets documentation to learn more.

Introducing Runnable Endpoint

Test API endpoints directly from your documentation with our new interactive component. Runnable Endpoint allows your users to send real HTTP requests to your API without leaving your docs, making it easier for developers to explore and understand your API.

Embed the component anywhere in your MDX documentation to create an interactive request builder with form inputs for headers, path parameters, query parameters, and request bodies. Users can execute requests and see real-time responses, complete with status codes and syntax highlighting.

Key features include:

• Interactive form builder that automatically generates inputs based on your endpoint definition
• Multiple examples support with a dropdown selector when you have multiple pre-configured scenarios
• Environment selector for testing against production, staging, or development
• Form persistence that saves user input in local storage across sessions
• Direct navigation to the full API reference with an “Open in API reference” button

To learn more about using Runnable Endpoints in your documentation, visit the Runnable Endpoint docs.