Skip to content

Repository files navigation

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.

Published on NPM

Tests and publishing

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-method-documentation

In an html file

<html><head><scripttype="module">import'@api-components/api-method-documentation/api-method-documentation.js';</script></head><body><api-method-documentationamf="..." endpoint="..." method="..."></api-method-documentation></body></html>

In a LitElement

import{LitElement,html}from'lit-element';import'@api-components/api-method-documentation/api-method-documentation.js';classSampleElementextendsPolymerElement{render(){returnhtml`<api-method-documentation.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}"></api-method-documentation> `;}_tryitHandler(e){console.log('opening api-request-panel...');}}customElements.define('sample-element',SampleElement);

Development

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

Running the demo locally

npm start

Running the tests

npm test

About

⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.

Topics

Resources

Stars

0 stars

Watchers

2 watching

Forks

Used by

Contributors

Languages