OpenApi Render Engine
Overview
The OpenAPI render engine is based on the Swagger UI component.Installation
- using
npm
```bash npm i @kyma-project/dc-open-api-render-engine ```
- using
yarn
```bash yarn add @kyma-project/dc-open-api-render-engine ```
Configuration
| Name | Required | Type | Default value | Description | | ----------- | -------- | ----- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |plugins
| No | any
| []
| Defines custom plugins for the Swagger UI component. Read this document for more details. |
| schemaUrl
| No | any
| {}
| Defines the custom schema for the SwaggerUI component. |NOTE: To learn how to pass options of a render engine, read this document.
Styles
To use default styles based on SAP Fundamentals, import them as follows:import "@kyma-project/dc-open-api-render-engine/lib/styles.css";
To use the default font
72
provided by SAP Fundamentals, install the npm package from this Getting Started guide and import the font as follows:import "fiori-fundamentals/dist/fonts.min.css";