Skip to content

Conversation

olehshh
Copy link
Member

@olehshh olehshh commented Sep 11, 2025

<DownloadOasButton/>

Overview

Add an OpenAPI Download Button to your documentation, allowing users to download your OpenAPI JSON file with one click.

Screenshot 2025-09-11 at 4 55 30 PM

Usage

<DownloadOasButton url="https://your-domain.com/openapi/openapi.json" />

How to Find Your OpenAPI URL

  1. Go to your ReadMe project
  2. In edit mode, navigate to the "API Reference" section and open the "API Definitions" tab
  3. Find the desired definition, click the dropdown next to it, and select "View OAS File"
  4. Copy the URL that appears and add it to the component

Make sure your definition is publicly accessible:

  • Go to Settings → General
  • In the "OpenAPI Access" section, set "View Permissions" to "Public"

Props

  • url (required): The URL to your OpenAPI JSON file

@olehshh olehshh marked this pull request as draft September 11, 2025 13:10
@olehshh olehshh marked this pull request as ready for review September 11, 2025 13:15
@olehshh olehshh requested a review from trishaprile September 11, 2025 13:15
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