api-render-ui
v1.0.4
Published
api-render-ui is a UI library that pursues simple and efficient data rendering for openapi.
Maintainers
cong.walk123Readme
api-render-ui is a UI library that pursues simple and efficient data rendering for openapi.
Table of contents
[![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-downloads-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
<head>
<title>API Renderer Demo</title>
<link rel="stylesheet" href="./api-render-ui.css">
</head>
<body>
<div id="apiContainer"></div>
<script src="./api-render-ui.js"></script>
<script>
const apiRenderer = new ApiRenderer({
mountPoint: '#apiContainer',
});
const openapiSpec = {...};
apiRenderer.render(openapiSpec);
</script>
</body>Installation
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 18 or higher is required.
If this is a brand new project, make sure to create a package.json first with
the npm init command.
Installation is done using the
npm install command:
npm install api-render-uiFeatures
- convert openapi spec data to api list.Only openapi 3.0+ is supported now.
- Api unit UI.