api-parameters-document
Documentation component for API query and URI parameters based on AMF data model.
Version compatibility
This version only works with AMF model version 2 (AMF parser >= 4.0.0).
For compatibility with previous model version use 3.x.x version of the component.
Usage
Installation
npm install --save @api-components/api-parameters-documentIn an html file
<html>
<head>
<script type="module">
import '@api-components/api-parameters-document/api-parameters-document.js';
</script>
</head>
<body>
<api-parameters-document></api-parameters-document>
</body>
</html>import { LitElement, html } from 'lit-element';
import '@api-components/api-parameters-document/api-parameters-document.js';
class SampleElement extends PolymerElement {
render() {
return html`
<api-parameters-document .amf="${this.amf}"></api-parameters-document>
`;
}
}
customElements.define('sample-element', SampleElement);Development
git clone https://github.com/api-components/api-parameters-document
cd api-parameters-document
npm installRunning the demo locally
npm startRunning the tests
npm test