5.2.21 • Published 3 days ago

@api-components/api-method-documentation v5.2.21

Weekly downloads
603
License
Apache-2.0
Repository
github
Last release
3 days ago

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>
    <script type="module">
      import '@api-components/api-method-documentation/api-method-documentation.js';
    </script>
  </head>
  <body>
    <api-method-documentation amf="..." 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';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <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
api-componentsapi-consoledocumentationmethod-documentation
@advanced-rest-client/arc-icons@advanced-rest-client/arc-marked@advanced-rest-client/clipboard-copy@advanced-rest-client/http-code-snippets@advanced-rest-client/markdown-styles@anypoint-web-components/anypoint-button@anypoint-web-components/anypoint-collapse@anypoint-web-components/anypoint-dropdown@anypoint-web-components/anypoint-item@anypoint-web-components/anypoint-listbox@api-components/amf-helper-mixin@api-components/api-annotation-document@api-components/api-body-document@api-components/api-example-generator@api-components/api-headers-document@api-components/api-parameters-document@api-components/api-responses-document@api-components/api-security-documentation@api-components/http-method-labellit-elementlit-html
@infinitebrahmanuniverse/nolb-_api@everything-registry/sub-chunk-73@api-components/api-summary@api-components/api-documentation@api-components/api-endpoint-documentation@zalastax/nolb-_api
5.2.21

3 days ago

5.2.20

3 days ago

5.2.19

7 days ago

5.2.18

7 days ago

5.2.17

8 days ago

5.2.16

10 days ago

5.2.15

6 months ago

5.2.14

1 year ago

5.2.13

2 years ago

5.2.12

2 years ago

5.2.11

2 years ago

5.2.10

2 years ago

5.2.9

2 years ago

5.2.8

2 years ago

5.2.7

2 years ago

5.2.6

3 years ago

5.2.5

3 years ago

5.2.4

3 years ago

5.2.3

3 years ago

5.2.2

3 years ago

5.2.1

3 years ago

5.2.0

3 years ago

5.1.10

3 years ago

5.1.9

3 years ago

5.1.8

3 years ago

5.1.7

3 years ago

5.1.6

3 years ago

5.1.5

3 years ago

5.1.4

3 years ago

5.1.3

3 years ago

5.1.2

3 years ago

5.1.1

3 years ago

5.1.0

3 years ago

5.0.6

3 years ago

5.0.5

3 years ago

5.0.4

3 years ago

5.0.3

3 years ago

5.0.2

3 years ago

5.0.1

4 years ago

5.0.0

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.8

4 years ago

4.0.7

4 years ago

4.0.5

4 years ago

4.0.6

4 years ago

4.0.4

4 years ago

4.0.3

4 years ago

4.0.2

4 years ago

4.0.1

5 years ago

4.0.0

5 years ago

3.0.7

5 years ago

3.0.6

5 years ago

3.0.5

5 years ago

3.0.4

5 years ago

3.0.3

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

3.0.0-preview.4

5 years ago

3.0.0-preview.3

5 years ago

3.0.0-preview.2

5 years ago

3.0.0-preview.1

5 years ago

2.0.7

6 years ago

2.0.6

6 years ago

2.0.5

6 years ago

2.0.0

6 years ago