@api-components/api-headers-document

Documentation component for API headers based on AMF data model

Usage no npm install needed!

<script type="module">
  import apiComponentsApiHeadersDocument from 'https://cdn.skypack.dev/@api-components/api-headers-document';
</script>

README

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.

Documentation component for API headers based on AMF data model.

Published on NPM

Tests and publishing

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-headers-document

In an html file

<html>
   <head>
     <script type="module">
       import '@api-components/api-headers-document/api-headers-document.js';
     </script>
   </head>
   <body>
     <api-headers-document></api-headers-document>
   </body>
</html>

import { LitElement, html } from 'lit-element';
import '@api-components/api-headers-document/api-headers-document.js';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <api-headers-document .amf="${this.amf}"></api-headers-document>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Development

git clone https://github.com/api-components/api-headers-document
cd api-headers-document
npm install

Running the demo locally

npm start

Running the tests

npm test