2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2023-05-25 10:46:07 +00:00
< meta name = "generator" content = "Hugo 0.112.3" >
2023-05-25 13:52:57 +00:00
< meta name = "generator" content = "Relearn 5.15.1+tip" >
2023-05-14 21:06:26 +00:00
< meta name = "description" content = "UI for your OpenAPI / Swagger specifications" >
2022-04-02 13:30:16 +00:00
< meta name = "author" content = "Sören Weber" >
2023-05-14 21:06:26 +00:00
< title > OpenAPI :: Hugo Relearn Theme< / title >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html" rel = "alternate" hreflang = "pir" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html" rel = "canonical" type = "text/html" title = "OpenAPI :: Hugo Relearn Theme" >
< link href = "../../shortcodes/openapi/index.xml" rel = "alternate" type = "application/rss+xml" title = "OpenAPI :: Hugo Relearn Theme" >
2023-05-26 06:40:21 +00:00
< link href = "../../images/logo.svg?1685083212" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-05-26 06:40:21 +00:00
< link href = "../../css/fontawesome-all.min.css?1685083214" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1685083214" rel = "stylesheet" > < / noscript >
< link href = "../../css/nucleus.css?1685083214" rel = "stylesheet" >
< link href = "../../css/auto-complete.css?1685083214" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1685083214" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1685083214" rel = "stylesheet" >
< link href = "../../css/fonts.css?1685083214" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1685083214" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1685083214" rel = "stylesheet" >
< link href = "../../css/theme-auto.css?1685083214" rel = "stylesheet" id = "variant-style" >
< link href = "../../css/variant.css?1685083214" rel = "stylesheet" >
< link href = "../../css/print.css?1685083214" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1685083214" rel = "stylesheet" >
< link href = "../../css/ie.css?1685083214" rel = "stylesheet" >
< script src = "../../js/url.js?1685083214" > < / script >
< script src = "../../js/variant.js?1685083214" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2023-02-25 21:51:39 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2023-05-14 21:06:26 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../shortcodes/openapi/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2023-02-08 23:54:12 +00:00
< nav id = "topbar" class = "highlightable" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2023-02-04 15:02:34 +00:00
< a href = "#" id = "sidebar-toggle" class = "topbar-link" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2023-05-18 20:52:30 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../index.html" > < span itemprop = "name" > Hugo Relearn Theme< / span > < / a > < meta itemprop = "position" content = "1" > > < / li >
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../shortcodes/index.html" > < span itemprop = "name" > Shortcodes< / span > < / a > < meta itemprop = "position" content = "2" > > < / li >
2023-05-14 21:06:26 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > OpenAPI< / span > < meta itemprop = "position" content = "3" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-05-14 21:06:26 +00:00
< h1 id = "openapi" > OpenAPI< / h1 >
2022-07-05 22:16:52 +00:00
2023-05-14 21:06:26 +00:00
< p > The < code > openapi< / code > shortcode uses the < a href = "https://github.com/swagger-api/swagger-ui" target = "_blank" > Swagger UI< / a > library to display your OpenAPI / Swagger specifications.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works in modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2023-05-14 21:06:26 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > openapi< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " https://petstore3.openapi.io/api/v3/openapi.json" < / span > < span class = "p" > > }}< / span >
2023-05-25 10:46:07 +00:00
< / span > < / span > < / code > < / pre > < / div > < / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2023-05-14 21:06:26 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/openapi.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
2023-05-14 21:06:26 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " src" < / span > < span class = "s" > " https://petstore3.openapi.io/api/v3/openapi.json" < / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2023-05-25 10:46:07 +00:00
< / span > < / span > < / code > < / pre > < / div > < / div >
2022-06-22 22:08:50 +00:00
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > src< / strong > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2023-05-14 21:06:26 +00:00
< td style = "text-align:left" > 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.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
2022-10-06 20:51:16 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2023-05-14 21:06:26 +00:00
< p > 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.< / p >
2022-12-16 17:42:17 +00:00
< p > Instead, open the < a href = "../../basics/configuration/#activate-print-support" > print preview< / a > in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-10-06 20:51:16 +00:00
< / div >
2023-05-14 21:06:26 +00:00
< h2 id = "example" > Example< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "using-local-file" > Using Local File< / h3 >
2023-05-14 21:06:26 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > openapi< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " petstore.json" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-05-14 21:06:26 +00:00
< div class = "sc-openapi-wrapper is-loading helper-loading-container" >
< div
class="sc-openapi-container"
2023-05-26 06:40:21 +00:00
id="openapi-8d13e2a587a2a3d38a8a28d9aeb85b7a"
2023-05-14 21:06:26 +00:00
openapi-url="../../shortcodes/openapi/petstore.json"
>< / div >
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
2023-05-26 06:40:21 +00:00
2022-04-02 13:30:16 +00:00
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
2022-04-02 13:30:16 +00:00
< / div >
< / main >
< / div >
2023-05-26 06:40:21 +00:00
< script src = "../../js/clipboard.min.js?1685083215" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1685083215" defer > < / script >
2023-05-16 02:04:42 +00:00
< script > window . noZensmooth = true ; < / script >
2023-05-26 06:40:21 +00:00
< script src = "../../js/swagger-ui/swagger-ui-bundle.js?1685083215" defer > < / script >
< script src = "../../js/swagger-ui/swagger-ui-standalone-preset.js?1685083215" defer > < / script >
2022-04-02 13:30:16 +00:00
< script >
2023-05-26 06:40:21 +00:00
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1685083215", assetsBuster: 1685083215 };
2022-04-02 13:30:16 +00:00
< / script >
2023-05-26 06:40:21 +00:00
< script src = "../../js/theme.js?1685083215" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
