Skip to content

Added Interactive API Documentation#12

Open
RijulTP wants to merge 1 commit intoshadowoff09:mainfrom
RijulTP:liveapidocs
Open

Added Interactive API Documentation#12
RijulTP wants to merge 1 commit intoshadowoff09:mainfrom
RijulTP:liveapidocs

Conversation

@RijulTP
Copy link
Copy Markdown

@RijulTP RijulTP commented Oct 9, 2024

Add LiveAPI Widget to Documentation

Description

This PR introduces the LiveAPI Widget, enabling users to execute APIs directly from the documentation and generate code snippets in various languages. This improves the interactive experience of the documentation and helps developers quickly test and integrate APIs.

Key Features

  • API Execution: Users can try out APIs within the documentation by clicking on the "Try It" button.
  • Code Snippet Generation: The widget supports multiple programming languages, allowing users to convert API requests into code snippets.
  • Production-Only Visibility: The widget is embedded in a way that ensures it is only visible in the production environment.

Demo Screenshots

1. Clicking "Try It" and getting the API response

image

2. Choosing Languages in the code converter

image

3. Result of code conversion

image


Testing & Validation

The widget was tested in both development and production environments to ensure proper functionality and appearance. It will only be visible in production.

@vercel
Copy link
Copy Markdown

vercel Bot commented Oct 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
cinema-quotes ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2024 3:44am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant