Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apiaryio/api-elements.js
Library for consuming API Elements in JavaScript
https://github.com/apiaryio/api-elements.js
api-elements
Last synced: about 1 month ago
JSON representation
Library for consuming API Elements in JavaScript
- Host: GitHub
- URL: https://github.com/apiaryio/api-elements.js
- Owner: apiaryio
- License: mit
- Created: 2018-01-15T22:52:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-28T18:03:00.000Z (about 1 year ago)
- Last Synced: 2024-07-29T15:39:15.936Z (about 2 months ago)
- Topics: api-elements
- Language: JavaScript
- Homepage: https://apielements.org/
- Size: 3.92 MB
- Stars: 74
- Watchers: 12
- Forks: 18
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - apiaryio/api-elements.js - Library for consuming API Elements in JavaScript (JavaScript)
README
# API Elements: JavaScript
[API Elements](https://apielements.org/) is a uniform interface for dealing
with API description formats ([API Blueprint](https://apiblueprint.org/), [OpenAPI](https://github.com/OAI/OpenAPI-Specification), ...). This repository contains tooling for handling API
Elements in JavaScript along with parsers and serializers for API description
languages. [@apielements/cli](packages/cli) provides a command line interface to
API Elements which can be used to validate API Description Documents.
API Elements adapters:
- [API Blueprint Parser](packages/apib-parser)
- [API Blueprint Serializer](packages/apib-serializer)
- [OpenAPI 2 Parser](packages/openapi2-parser)
- [OpenAPI 3 Parser](packages/openapi3-parser)
## Usage
```javascript
const { Fury } = require('@apielements/core');
const fury = new Fury();
// Load any parsers or serializer adapters you wish to use
const apiBlueprintParser = require('@apielements/apib-parser');
fury.use(apiBlueprintParser);
const openAPI2Parser = require('@apielements/openapi2-parser');
fury.use(openAPI2Parser);
const source = `
FORMAT: 1A
# My API
## GET /message
+ Response 200 (text/plain)
Hello World!
`;
fury.parse({source}, (error, parseResult) => {
console.log(parseResult.api.title);
});
```
See [API Reference documentation](https://api-elements-js.readthedocs.io/en/latest/api.html#elements)
for the details about the ParseResult object and other elements interface in
JavaScript.
[API Elements
Reference](https://apielements.org/en/latest/element-definitions.html) contains
information regarding the design of various API Elements.
## Development
### Using Lerna
Install dependencies of all packages:
```shell
$ npm install --global yarn
$ yarn
```
> **NOTE**: Please do commit the `yarn.lock` to the GitHub repo
To list all packages:
```shell
$ npx lerna ls -a -l
```
To add a new dependency to a package:
```shell
$ npx lerna add --scope='package_name' dep@version
```
To run tests for a single package:
```shell
$ npx lerna exec --scope='package_name' -- npm run test
```
### Documentation
The documentation is built using Sphinx, a Python tool. Assuming you have
Python 3 and
[pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)
installed, the following steps can be used to build the site.
```shell
$ cd docs
$ pipenv install --dev
```
#### Running the Development Server
You can run a local development server to preview changes using the following:
```shell
$ cd docs
$ pipenv run serve
```