Nominating Presidential Muppets

    @api-components/api-parameters-document
    TypeScript icon, indicating that this package has built-in type declarations

    4.1.3 • Public • Published

    api-parameters-document

    Published on NPM

    Tests and publishing

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

    In 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 install

    Running the demo locally

    npm start

    Running the tests

    npm test

    Install

    npm i @api-components/api-parameters-document

    DownloadsWeekly Downloads

    397

    Version

    4.1.3

    License

    Apache-2.0

    Unpacked Size

    18.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • jarrodek
    • twoplustwoone
    • lbauret
    • carowright