Have ideas to improve npm?Join in the discussion! »

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

    4.2.0 • Public • Published

    api-annotation-document

    An element to render RAML annotations 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-annotation-document

    The element requires to set the amf property with the full generated AMF model to properly resolve compact JSON model. It also requires to set the shape property to whatever API property being currently documented (endpoint, method, type (including properties of a type which is also a type), security, security settings, and so on).

    In an html file

    <html>
      <head>
        <script type="module">
          import '@api-components/api-annotation-document/api-annotation-document.js';
        </script>
      </head>
      <body>
        <api-annotation-document></api-annotation-document>
        <script>
        {
          const model = await getAmfModelSomehow();
          const shape = computeCurrentShape(model, someId);
          const aad = document.querySelector('api-annotation-document');
          aad.amf = model;
          aad.shape = shape;
        }
        </script>
      </body>
    </html>

    In a LitElement

    import { LitElement, html } from 'lit-element';
    import '@api-components/api-annotation-document/api-annotation-document.js';
    
    class SampleElement extends LitElement {
      render() {
        return html`
        <api-annotation-document
          .amf="${this.model}"
          .shape="${this.shape}"
        ></api-annotation-document>
        `;
      }
    }
    customElements.define('sample-element', SampleElement);

    Development

    git clone https://github.com/advanced-rest-client/api-annotation-document
    cd api-annotation-document
    npm install

    Running the demo locally

    npm start

    Running the tests

    npm test

    Install

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

    DownloadsWeekly Downloads

    276

    Version

    4.2.0

    License

    Apache-2.0

    Unpacked Size

    17.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar