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" >
2022-11-17 21:58:05 +00:00
< meta name = "generator" content = "Hugo 0.106.0" >
2022-11-10 09:09:19 +00:00
< meta name = "generator" content = "Relearn 5.5.3+tip" >
2022-06-05 17:32:37 +00:00
< meta name = "description" content = "UI for your Swagger / OpenAPI Specifications" >
2022-04-02 13:30:16 +00:00
< meta name = "author" content = "Sören Weber" >
< title > Swagger :: Hugo Relearn Theme< / title >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/swagger/index.html" rel = "canonical" type = "text/html" title = "Swagger :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../../shortcodes/swagger/index.xml" rel = "alternate" type = "application/rss+xml" title = "Swagger :: Hugo Relearn Theme" >
2022-11-18 20:49:43 +00:00
< link href = "../../images/logo.svg?1668804577" 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 -->
2022-11-18 20:49:43 +00:00
< link href = "../../css/fontawesome-all.min.css?1668804578" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1668804578" rel = "stylesheet" > < / noscript >
< link href = "../../css/featherlight.min.css?1668804578" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/featherlight.min.css?1668804578" rel = "stylesheet" > < / noscript >
< link href = "../../css/auto-complete.css?1668804578" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1668804578" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1668804578" rel = "stylesheet" >
< link href = "../../css/nucleus.css?1668804578" rel = "stylesheet" >
< link href = "../../css/fonts.css?1668804578" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1668804578" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1668804578" rel = "stylesheet" >
< link href = "../../css/theme-relearn-light.css?1668804578" rel = "stylesheet" id = "variant-style" >
< link href = "../../css/ie.css?1668804578" rel = "stylesheet" >
< link href = "../../css/variant.css?1668804578" rel = "stylesheet" >
< link href = "../../css/print.css?1668804578" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1668804578" rel = "stylesheet" >
< script src = "../../js/url.js?1668804578" > < / script >
< script src = "../../js/variant.js?1668804578" > < / 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/';
2022-07-14 20:20:11 +00:00
window.variants & & variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-11-18 20:49:43 +00:00
< script src = "../../js/jquery.min.js?1668804578" defer > < / script >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../shortcodes/swagger/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 >
2022-11-07 19:58:08 +00:00
< nav id = "topbar" class = "highlightable" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2022-10-08 20:51:04 +00:00
< a href = "#" id = "sidebar-toggle" 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" >
2022-11-05 23:35:48 +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 >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Swagger< / 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" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "swagger" > Swagger< / h1 >
2022-07-05 22:16:52 +00:00
2022-06-05 17:32:37 +00:00
< p > This shortcode uses the < a href = "https://mrin9.github.io/RapiDoc" > RapiDoc< / a > library to display your Swagger / OpenAPI Specifications.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
2022-04-02 13:30:16 +00:00
< div class = "box-content" >
< p > This only works in modern browsers.< / p >
< / div >
< / 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 >
< div class = "tab-panel" >
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
2022-11-01 01:10:49 +00:00
class="tab-nav-button direction-ltr active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
>< span > shortcode< / span > < / button >
< button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
2022-11-01 01:10:49 +00:00
class="tab-nav-button direction-ltr "
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
>< span > partial< / span > < / button >
< / div >
< div class = "tab-content" >
< div data-tab-item = "shortcode" data-tab-group = "shortcode-parameter" class = "tab-item active" >
2022-06-05 17:32:37 +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" > swagger< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " https://petstore3.swagger.io/api/v3/openapi.json" < / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< div data-tab-item = "partial" data-tab-group = "shortcode-parameter" class = "tab-item " >
< 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/swagger.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " src" < / span > < span class = "s" > " https://petstore3.swagger.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 >
< 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 >
< 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 >
< / tr >
< / tbody >
< / table >
2022-10-06 20:51:16 +00:00
< 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 Swagger documentation, don’ t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.< / p >
2022-11-05 23:35:48 +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-10-06 20:51:16 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "configuration" > Configuration< / h2 >
< p > Swagger is configured with default settings. You can customize Swagger’ s default settings for all of your files thru a JSON object in your < code > config.toml< / code > or override these settings per page thru your pages frontmatter.< / p >
< p > The JSON object of your < code > config.toml< / code > / frontmatter is forwarded into Swagger’ s initialization. At the moment, only the < code > theme< / code > setting is supported.< / p >
< p > The < code > theme< / code > setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in < code > config.toml< / code > or frontmatter.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "global-configuration-file" > Global Configuration File< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > swaggerInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "example" > Example< / h2 >
< h3 id = "using-local-file" > Using Local File< / h3 >
2022-04-02 13:30:16 +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" > swagger< / 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 >
2022-04-02 13:30:16 +00:00
< rapi-doc
2022-10-06 13:49:10 +00:00
allow-spec-file-download="false"
allow-server-selection="false"
allow-try="false"
2022-10-06 20:30:40 +00:00
font-size="default"
2022-10-06 13:49:10 +00:00
render-style="read"
2022-04-02 13:30:16 +00:00
default-schema-tab="example"
layout="column"
load-fonts="false"
schema-description-expanded="true"
schema-style="table"
show-header="false"
2022-11-05 23:35:48 +00:00
spec-url="../../shortcodes/swagger/petstore.json"
2022-04-02 13:30:16 +00:00
sort-tags="true"
>< / rapi-doc >
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2022-11-18 20:49:43 +00:00
< script src = "../../js/clipboard.min.js?1668804579" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1668804579" defer > < / script >
< script src = "../../js/featherlight.min.js?1668804579" defer > < / script >
< script src = "../../js/rapidoc-min.js?1668804579" defer > < / script >
2022-04-02 13:30:16 +00:00
< script >
2022-07-17 18:04:59 +00:00
window.themeUseSwagger = JSON.parse("{}");
2022-04-02 13:30:16 +00:00
< / script >
2022-11-18 20:49:43 +00:00
< script src = "../../js/theme.js?1668804579" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
