@api-components/api-example-generator

v4.4.29

Published

7 months ago

Examples generator from AMF model

Downloads

1,977

0High
0Medium
0Low

api-components examples generator

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.

The tests and the logic were migrated to the @api-components/api-schema module.

Generates examples from the AMF 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.

Breaking

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.

Usage

Installation

npm install --save @api-components/api-example-generator

API

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', {...});

In an html file

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>

In a LitElement element

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);

Listing media types for payloads

Use listMedia() which accepts list of payloads or a single payload definition.

Example for Payload(s)

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.

Example from any AMF shape

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.

Development

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

Running the demo locally

npm start

Running the tests

npm test