Swagger UI

Embed the Swagger UI and point it to your OpenApi.json spec.

100: [swaggerUi]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "swaggerUi"
    allSwaggerOptions: {}
    openApiSource: empty string
    swaggerElementId: swagger-ui
    swaggerUiVersion: 3.5.0

Key Type Default Value Description
allSwaggerOptions JSONObject {}

The full JSON object that initializes the Swagger UI, allowing you to completely customize it.

openApiSource String empty string

The URL containing the OpenAPI definition.

swaggerElementId String swagger-ui

The ID of the element that should contain the Swagger UI.

swaggerUiVersion String 3.5.0

The version of SwaggerUI to use.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

extraCss String[] empty array

Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site's assets.

hidden boolean false

When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.

noWrapper boolean false

When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.

order int 0

By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.

template String[] empty array

Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.

No archetypes