The openapi shortcode uses the Swagger UI library to display your OpenAPI / Swagger specifications.


This only works in modern browsers.


While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

{{< openapi src="" >}}
{{ partial "shortcodes/openapi.html" (dict
  "page" .
  "src"  ""


Name Default Notes
src <empty> The URL to the OpenAPI specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.

If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.

Instead, open the print preview in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.


Using Local File

{{< openapi src="petstore.json" >}}