mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
201 lines
12 KiB
HTML
201 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.120.4">
|
|
<meta name="generator" content="Relearn 5.23.2+tip">
|
|
<meta name="description" content="UI for your OpenAPI / Swagger specifications">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="OpenAPI :: Hugo Relearn Theme">
|
|
<meta name="twitter:description" content="UI for your OpenAPI / Swagger specifications">
|
|
<meta property="og:title" content="OpenAPI :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="UI for your OpenAPI / Swagger specifications">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html">
|
|
<meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<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="art-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">
|
|
<link href="../../images/logo.svg?1701463044" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="../../css/fontawesome-all.min.css?1701463045" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1701463045" rel="stylesheet"></noscript>
|
|
<link href="../../css/nucleus.css?1701463045" rel="stylesheet">
|
|
<link href="../../css/auto-complete.css?1701463045" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1701463045" rel="stylesheet"></noscript>
|
|
<link href="../../css/perfect-scrollbar.min.css?1701463045" rel="stylesheet">
|
|
<link href="../../css/fonts.css?1701463045" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1701463045" rel="stylesheet"></noscript>
|
|
<link href="../../css/theme.css?1701463045" rel="stylesheet">
|
|
<link href="../../css/theme-relearn-auto.css?1701463045" rel="stylesheet" id="R-variant-style">
|
|
<link href="../../css/chroma-relearn-auto.css?1701463045" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="../../css/variant.css?1701463045" rel="stylesheet">
|
|
<link href="../../css/print.css?1701463045" rel="stylesheet" media="print">
|
|
<link href="../../css/format-print.css?1701463045" rel="stylesheet">
|
|
<link href="../../css/ie.css?1701463045" rel="stylesheet">
|
|
<script src="../../js/url.js?1701463045"></script>
|
|
<script src="../../js/variant.js?1701463045"></script>
|
|
<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
|
|
window.index_js_url="../../index.search.js";
|
|
var root_url="../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// 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!`;
|
|
window.T_Reset_view = `Reset view`;
|
|
window.T_View_reset = `View reset!`;
|
|
window.T_No_results_found = `No results found for "{0}"`;
|
|
window.T_N_results_found = `{1} results found for "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../shortcodes/openapi/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide">
|
|
<button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)">
|
|
<i class="fa-fw fas fa-bars"></i>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><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="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">OpenAPI</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
<h1 id="openapi">OpenAPI</h1>
|
|
|
|
<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>
|
|
|
|
<div class="box notices cstyle note">
|
|
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
|
<div class="box-content">
|
|
|
|
<p>This only works in modern browsers.</p>
|
|
</div>
|
|
</div>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
|
|
|
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span class="tab-nav-text">shortcode</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span class="tab-nav-text">partial</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="shortcode"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
|
|
<div class="wrap-code 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></span></span></code></pre></div></div>
|
|
</div>
|
|
<div
|
|
data-tab-item="partial"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
|
|
<div class="wrap-code 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>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
|
</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>
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Default</th>
|
|
<th>Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><strong>src</strong></td>
|
|
<td><em><empty></em></td>
|
|
<td>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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<div class="box notices cstyle note">
|
|
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
|
<div class="box-content">
|
|
|
|
<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>
|
|
<p>Instead, open the <a href="../../basics/customization/index.html#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>
|
|
</div>
|
|
</div>
|
|
<h2 id="example">Example</h2>
|
|
<h3 id="using-local-file">Using Local File</h3>
|
|
<div class="wrap-code 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></span></span></code></pre></div>
|
|
<div class="sc-openapi-wrapper is-loading helper-loading-container">
|
|
<div
|
|
class="sc-openapi-container"
|
|
id="R-openapi-42258174b445fadec18544fc7889c792"
|
|
data-openapi-url="../../shortcodes/openapi/petstore.json"
|
|
></div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../js/clipboard.min.js?1701463045" defer></script>
|
|
<script src="../../js/perfect-scrollbar.min.js?1701463045" defer></script>
|
|
<script>window.noZensmooth = true;</script>
|
|
<script src="../../js/swagger-ui/swagger-ui-bundle.js?1701463045" defer></script>
|
|
<script src="../../js/swagger-ui/swagger-ui-standalone-preset.js?1701463045" defer></script>
|
|
<script>
|
|
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1701463045", assetsBuster: 1701463045 };
|
|
</script>
|
|
<script src="../../js/theme.js?1701463045" defer></script>
|
|
</body>
|
|
</html>
|