mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-03-20 16:15:09 +00:00
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
|
---
|
||
|
|
description: "Adds UI for your Swagger / OpenAPI Specifications"
|
||
|
|
title: "Swagger"
|
||
|
|
---
|
||
|
|
|
||
|
|
This shortcode uses the [RapiDoc](https://mrin9.github.io/RapiDoc) library to display your OpenAPI Specifications.
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
Swagger is configured with default settings. You can customize Swagger's default settings for all of your files thru a JSON object in your `config.toml` or override these settings per page thru your pages frontmatter.
|
||
|
|
|
||
|
|
The JSON object of your `config.toml` / frontmatter is forwarded into Swagger's initialization. At the moment, only the `theme` setting is supported.
|
||
|
|
|
||
|
|
The `theme` 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 `config.toml`, or frontmatter.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
````toml
|
||
|
|
[params]
|
||
|
|
swaggerInitialize = "{ \"theme\": \"dark\" }"
|
||
|
|
````
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Just insert your Mermaid code in the `mermaid` shortcode like this:
|
||
|
|
|
||
|
|
````go
|
||
|
|
{{</* swagger src="https://petstore3.swagger.io/api/v3/openapi.json" */>}}
|
||
|
|
````
|
||
|
|
|
||
|
|
The `src` parameter is mandatory and can be either an absolute URL or a relative one pointing into your Hugo file system.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
{{< swagger src="https://petstore3.swagger.io/api/v3/openapi.json" >}}
|