Initial check-in after refactoring to use Hugo site generator with ReLearn template. HTTP Status Codes page not done--nor adwords added.
This commit is contained in:
@ -0,0 +1,48 @@
|
||||
---
|
||||
description: "UI for your Swagger / OpenAPI Specifications"
|
||||
title: "Swagger"
|
||||
---
|
||||
|
||||
This shortcode uses the [RapiDoc](https://mrin9.github.io/RapiDoc) library to display your Swagger / OpenAPI Specifications.
|
||||
|
||||
{{% notice note %}}
|
||||
This only works in modern browsers.
|
||||
{{% /notice %}}
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
````go
|
||||
{{</* swagger src="https://petstore3.swagger.io/api/v3/openapi.json" */>}}
|
||||
````
|
||||
|
||||
### Parameter
|
||||
|
||||
| Name | Default | Notes |
|
||||
|:---------------------|:-----------------|:------------|
|
||||
| **src** | _<empty>_ | 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. |
|
||||
|
||||
## 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.
|
||||
|
||||
### Global Configuration File
|
||||
|
||||
````toml
|
||||
[params]
|
||||
swaggerInitialize = "{ \"theme\": \"dark\" }"
|
||||
````
|
||||
|
||||
## Example
|
||||
|
||||
### Using Local File
|
||||
|
||||
````go
|
||||
{{</* swagger src="petstore.json" */>}}
|
||||
````
|
||||
|
||||
{{< swagger src="petstore.json" >}}
|
||||
Reference in New Issue
Block a user