https://github.com/advanced-rest-client/api-security-documentation

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

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-security-documentation
• Owner: advanced-rest-client
• Created: 2018-04-20T07:40:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T12:57:09.000Z (over 1 year ago)
• Last Synced: 2024-04-14T21:18:37.094Z (8 months ago)
• Topics: deprecated, obsolete
• Language: JavaScript
• Homepage:
• Size: 2.62 MB
• Stars: 0
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DEPRECATED

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

-----

Documentation view for AMF security model of an API.

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

[![Tests and publishing](https://github.com/advanced-rest-client/api-security-documentation/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-security-documentation/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-security-documentation

```

The component requires to set 2 properties: `amf` and `security`.

The `amf` property is the whole API model generated by the AMF parser. This property is used to resolve compact moodel's keys.

The `security` property is the part of the API model describing security method. The shape type is `http://a.ml/vocabularies/security#SecurityScheme`.

### In an html file

```html

  

    

      import '@api-components/api-security-documentation/api-security-documentation.js';

    

  

  

    

  

```

### In a LitElement

```js

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

import '@api-components/api-security-documentation/api-security-documentation.js';

class SampleElement extends PolymerElement {

  static get properties() {

    return {

      // AMF model for selected security

      security: { type: Object }

    };

  }

  render() {

    return html`

    

    `;

  }

}

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

```

## Development

```sh

git clone https://github.com/advanced-rest-client/api-security-documentation

cd api-security-documentation

npm install

```

### Running the demo locally

```sh

npm start

```

### Running the tests

```sh

npm test

```