Package Exports
- @kyma-project/dc-open-api-render-engine
- @kyma-project/dc-open-api-render-engine/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@kyma-project/dc-open-api-render-engine) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
OpenApi Render Engine
Overview
The OpenAPI render engine is based on the Swagger UI component.
Installation
using
npmnpm i @kyma-project/dc-open-api-render-engineusing
yarnyarn 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";