DEPRECATED
This component is being deprecated. The code base has been moved to api-documentation module. This module will be archived when PR 37 is merged.
A documentation module for RAML types (resources) using AMF ld+json 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-type-documentationIn an html file
<html>
<head>
<script type="module">
import '@api-components/api-type-documentation/api-type-documentation.js';
</script>
</head>
<body>
<api-type-documentation></api-type-documentation>
</body>
</html>In a LitElement
import { LitElement, html } from 'lit-element';
import '@api-components/api-type-documentation/api-type-documentation.js';
class SampleElement extends PolymerElement {
render() {
return html`
<api-type-documentation .amf="${this.amf}"></api-type-documentation>
`;
}
}
customElements.define('sample-element', SampleElement);Development
git clone https://github.com/advanced-rest-client/api-type-documentation
cd api-type-documentation
npm installRunning the demo locally
npm startRunning the tests
npm testAPI components
This component is a part of API components ecosystem