https://github.com/advanced-rest-client/api-body-document
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
https://github.com/advanced-rest-client/api-body-document
deprecated obsolete
Last synced: 5 months ago
JSON representation
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
- Host: GitHub
- URL: https://github.com/advanced-rest-client/api-body-document
- Owner: advanced-rest-client
- Created: 2018-04-12T03:09:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-15T13:56:34.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T21:18:37.341Z (about 1 year ago)
- Topics: deprecated, obsolete
- Language: JavaScript
- Homepage:
- Size: 3.42 MB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
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 component to render HTTP method body documentation based on AMF model generated from API spec file.
## 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-body-document
```
### In an html file
```html
import '@api-components/api-body-document/api-body-document.js';
```
### In a LitElement
```js
import { LitElement, html } from 'lit-element';
import '@api-components/api-body-document/api-body-document.js';
class SampleElement extends PolymerElement {
render() {
return html`
`;
}
}
customElements.define('sample-element', SampleElement);
```
## Development
```sh
git clone https://github.com/advanced-rest-client/api-body-document
cd api-body-document
npm install
```
### Running the demo locally
```sh
npm start
```
### Running the tests
```sh
npm test
```