@salesforcedevs/sfdocs-api-body-document
Advanced tools
A component to render HTTP method body documentation based on AMF model
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.
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.
npm install --save @api-components/api-body-document
<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>
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);
git clone https://github.com/advanced-rest-client/api-body-document
cd api-body-document
npm install
npm start
npm test
FAQs
A component to render HTTP method body documentation based on AMF model
The npm package @salesforcedevs/sfdocs-api-body-document receives a total of 317 weekly downloads. As such, @salesforcedevs/sfdocs-api-body-document popularity was classified as not popular.
We found that @salesforcedevs/sfdocs-api-body-document demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 13 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.