@api-components/api-example-generator
Advanced tools
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.
The tests and the logic were migrated to the @api-components/api-schema module.
Generates examples from the AMF model.
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.
The api-example-generator custom element is deprecated and will be removed with the next major release.
The element was creates when the AmfHelperMixin needed a HTMLElement constructor. Now there is no such requirement and the not this works as a JS library.
npm install --save @api-components/api-example-generator
See src/ExampleGenerator for the public API.
import { ExampleGenerator } '@api-components/api-example-generator';
const gen = new ExampleGenerator(amfModel);
const examples = new gen.computeExamples(schema, 'application/json', {...});
This is deprecated
<html>
<head>
<script type="module">
import '@api-components/api-example-generator/api-example-generator.js';
</script>
</head>
<body>
<api-example-generator></api-example-generator>
</body>
</html>
This is deprecated
import { LitElement, html } from 'lit-element';
import '@api-components/api-example-generator/api-example-generator.js';
class SampleElement extends LitElement {
render() {
return html`
<api-example-generator .amf="${this.model}"></api-example-generator>
`;
}
}
customElements.define('sample-element', SampleElement);
Use listMedia() which accepts list of payloads or a single payload definition.
Use generatePayloadsExamples() to generate a list of examples for payload(s).
Provide second argument which is a media type that should be used to generate an example.
Currently only application/json and application/xml is supported.
Feel free to send a PR to add support for more media types.
The computeExamples() method tries to lookup an example property in any AMF shape.
If possible (and no rawOnly or noAuto option is set) then it generates an example
depending on passed object.
git clone https://github.com/advanced-rest-client/api-example-generator
cd api-example-generator
npm install
npm start
npm test
FAQs
Examples generator from AMF model
The npm package @api-components/api-example-generator receives a total of 451 weekly downloads. As such, @api-components/api-example-generator popularity was classified as not popular.
We found that @api-components/api-example-generator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.
Product
We’re excited to announce a powerful new capability in Socket: historical data and enhanced analytics.
Product
Module Reachability filters out unreachable CVEs so you can focus on vulnerabilities that actually matter to your application.