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 HTTP method documentation generated from an 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.

Usage

$3

``sh
npm install --save @api-components/api-method-documentation
`

$3

`html








`

$3

`js
import { LitElement, html } from 'lit-element';
import '@api-components/api-method-documentation/api-method-documentation.js';

class SampleElement extends PolymerElement {
render() {
return html
.amf="${this.amf}"
.server="${server}"
.endpoint="${this.endpoint}"
.method="${this.method}"
.previous="${this.previous}"
.next="${this.next}"
?renderCodeSnippets="${this.codeSnippets}"
?narrow="${this.narrow}"
.renderSecurity="${this.renderSecurity}"
.noTryIt="${this.noTryit}"
?legacy="${this.legacy}"
@tryit-requested="${this._tryitHandler}">
;
}

_tryitHandler(e) {
console.log('opening api-request-panel...');
}
}
customElements.define('sample-element', SampleElement);
`

Development

`sh
git clone https://github.com/api-components/api-method-documentation
cd api-method-documentation
npm install
`

$3

`sh
npm start
`

$3

`sh
npm test
``