https://github.com/advanced-rest-client/api-annotation-document

⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
https://github.com/advanced-rest-client/api-annotation-document

deprecated obsolete

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/advanced-rest-client/api-annotation-document
• Owner: advanced-rest-client
• Created: 2018-04-10T06:31:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:55:25.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T04:01:52.498Z (8 months ago)
• Topics: deprecated, obsolete
• Language: JavaScript
• Homepage:
• Size: 1.67 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DEPRECATED

This component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.

-----

An element to render RAML annotations based on AMF data model.

[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-annotation-document.svg)](https://www.npmjs.com/package/@api-components/api-annotation-document)

[![Tests and publishing](https://github.com/advanced-rest-client/api-annotation-document/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-annotation-document/actions/workflows/deployment.yml)

## 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

```sh

npm install --save @api-components/api-annotation-document

```

The element requires to set the `amf` property with the full generated AMF model to properly resolve compact JSON model. It also requires to set the `shape` property to whatever API property being currently documented (endpoint, method, type (including properties of a type which is also a type), security, security settings, and so on).

### In an html file

```html

  

    

      import '@api-components/api-annotation-document/api-annotation-document.js';

    

  

  

    

    

    {

      const model = await getAmfModelSomehow();

      const shape = computeCurrentShape(model, someId);

      const aad = document.querySelector('api-annotation-document');

      aad.amf = model;

      aad.shape = shape;

    }

    

  

```

### In a LitElement

```js

import { LitElement, html } from 'lit-element';

import '@api-components/api-annotation-document/api-annotation-document.js';

class SampleElement extends LitElement {

  render() {

    return html`

    

    `;

  }

}

customElements.define('sample-element', SampleElement);

```

## Development

```sh

git clone https://github.com/advanced-rest-client/api-annotation-document

cd api-annotation-document

npm install

```

### Running the demo locally

```sh

npm start

```

### Running the tests

```sh

npm test

```