Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/advanced-rest-client/api-responses-document
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
https://github.com/advanced-rest-client/api-responses-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-responses-document
- Owner: advanced-rest-client
- Created: 2018-04-12T23:11:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:35:21.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T04:43:50.950Z (about 2 months ago)
- Topics: deprecated, obsolete
- Language: JavaScript
- Homepage:
- Size: 1.62 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- 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.
-----
A documentation for HTTP method responses based on AMF model.
[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-responses-document.svg)](https://www.npmjs.com/package/@api-components/api-responses-document)
[![Tests and publishing](https://github.com/advanced-rest-client/api-responses-document/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-responses-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-responses-document
```### In an html file
```html
import '@api-components/api-responses-document/api-responses-document.js';
const model = await getAmfModel();
const returns = await getMethodReturns(model);
const doc = document.querySelector('api-responses-document');
doc.amf = model;
doc.returns = returns;
// Select a 400 response from auto generated list of available status codes
const index = doc.codes.indexOf(400);
doc.selected = index;
```
### In a LitElement
```js
import { LitElement, html } from 'lit-element';
import '@api-components/api-responses-document/api-responses-document.js';class SampleElement extends PolymerElement {
render() {
return html`
`;
}
}
customElements.define('sample-element', SampleElement);
```### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@api-components/api-responses-document/api-responses-document.js';class SampleElement extends PolymerElement {
static get template() {
return html`
`;
}
}
customElements.define('sample-element', SampleElement);
```## Development
```sh
git clone https://github.com/api-components/api-responses-document
cd api-responses-document
npm install
```### Running the demo locally
```sh
npm start
```### Running the tests
```sh
npm test
```