@salesforcedevs/sfdocs-api-body-document
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

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 component to render HTTP method body documentation based on AMF model generated from API spec file.

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

In an html file

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

In a LitElement

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

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

Development

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

Running the demo locally

npm start

Running the tests

npm test

Package Sidebar

Install

npm i @salesforcedevs/sfdocs-api-body-document

Weekly Downloads

493

Version

1.0.4

License

Apache-2.0

Unpacked Size

33.3 kB

Total Files

9

Last publish

Collaborators

  • kavin2208
  • scoppieters
  • v-vinay
  • madhurah
  • miles.vdw
  • sunnymsf
  • dkulan
  • jmrog
  • kharlowsf
  • muenzpraeger
  • developer-web-ops
  • lokeshnsf
  • kishore_nemalipuri
  • mbraga-sfdc
  • opendocs