Expose a Downloadable Version of your API Specification

Download Link

What

Expose an easily accessible downloadable version of your API Specification in published documentation via a link.

How

There are two methods for adding a downloadable version

Include link in documentation

Within a Documentation File

  1. Select the documentation file you want to modify
  2. Reference an OpenAPI File in your documentation file
  3. Check Include Download Link?

Via Specification Extension

  1. Select the modeling file you want to modify
  2. Select code view
  3. Add the extension x-stoplight: { docs: { includeDownloadLink: true } } to your API Specification

Related Articles