mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 11:13:06 +00:00
84 lines
3.8 KiB
Markdown
84 lines
3.8 KiB
Markdown
+++
|
|
aliases = "/shortcodes/swagger"
|
|
description = "UI for your OpenAPI / Swagger specifications"
|
|
frontmatter = ["customOpenapiURL", "openapi.errorlevel", "openapi.force"]
|
|
options = ["customOpenapiURL", "openapi.errorlevel", "openapi.force"]
|
|
title = "OpenAPI"
|
|
+++
|
|
|
|
The `openapi` shortcode displays your OpenAPI / Swagger specifications using the [Swagger UI](https://github.com/swagger-api/swagger-ui) library.
|
|
|
|
## Usage
|
|
|
|
{{< tabs groupid="shortcode-parameter">}}
|
|
{{% tab title="shortcode" %}}
|
|
|
|
````go
|
|
{{</* openapi src="https://petstore3.openapi.io/api/v3/openapi.json" */>}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{% tab title="partial" %}}
|
|
|
|
````go
|
|
{{ partial "shortcodes/openapi.html" (dict
|
|
"page" .
|
|
"src" "https://petstore3.openapi.io/api/v3/openapi.json"
|
|
)}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{< /tabs >}}
|
|
|
|
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](configuration/appearance/topbar/#print-support) in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.
|
|
|
|
### Parameter
|
|
|
|
| Name | Default | Notes |
|
|
|----------------------|------------------|-------------|
|
|
| **src** | _<empty>_ | The path to the to the OpenAPI specification resource or URL to be used. Resource paths adhere to [Hugo's logical path](https://gohugo.io/methods/page/path/). |
|
|
|
|
## Settings
|
|
|
|
### Enabling Link Warnings
|
|
|
|
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can use `openapi.errorlevel` to control what should happen if a local OpenAPI specification link can not be resolved to a resource.
|
|
|
|
If not set or empty, any unresolved link is written as given into the resulting output. If set to `warning` the same happens and an additional warning is printed in the built console. If set to `error` an error message is printed and the build is aborted.
|
|
|
|
Please note that this can not resolve files inside of your `static` directory. The file must be a resource of the page or the site.
|
|
|
|
### Loading an External Version of the Swagger UI Library
|
|
|
|
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} The theme uses the shipped Swagger UI library by default.
|
|
|
|
In case you want do use a different version of the Swagger UI library but don't want to override the shipped version, you can set `customOpenapiURL` to the URL of the external Swagger UI library.
|
|
|
|
#### Example
|
|
|
|
{{< multiconfig file=hugo >}}
|
|
[params]
|
|
customOpenapiURL = "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
|
|
{{< /multiconfig >}}
|
|
|
|
### Force Loading of the Swagger UI Library
|
|
|
|
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} The Swagger UI library will be loaded if the page contains an `openapi` shortcode or codefence.
|
|
|
|
You can force loading the Swagger UI library if no shortcode or codefence was used by setting `openapi.force=true`. If a shortcode or codefence was found, the option has no effect. This comes handy in case you are using scripting to render a spec.
|
|
|
|
### Setting a Specific Swagger UI Theme
|
|
|
|
The recommended way to configure your Swagger UI theme is to set the default value using the `--OPENAPI-theme` variable in your [color variant stylesheet](configuration/appearance/generator/). This allows your specs to look pretty when the user switches the color variant.
|
|
|
|
## Example
|
|
|
|
### Using Local File
|
|
|
|
````go
|
|
{{</* openapi src="petstore.json" */>}}
|
|
````
|
|
|
|
{{< openapi src="petstore.json" >}}
|