Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuchk4/bivrost
Data layer for JS applications
https://github.com/tuchk4/bivrost
api axios data-source fetch local-storage
Last synced: 12 days ago
JSON representation
Data layer for JS applications
- Host: GitHub
- URL: https://github.com/tuchk4/bivrost
- Owner: tuchk4
- License: mit
- Created: 2015-04-23T13:07:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-12-28T18:04:30.000Z (almost 6 years ago)
- Last Synced: 2024-10-04T09:30:29.867Z (about 1 month ago)
- Topics: api, axios, data-source, fetch, local-storage
- Language: JavaScript
- Homepage:
- Size: 1.2 MB
- Stars: 45
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [Bivrost](http://tuchk4.github.io/bivrost/)
Bivrost allows to organize a simple interface to asynchronous APIs.
[](https://travis-ci.org/tuchk4/bivrost)
[](https://www.npmjs.com/package/bivrost)
# Fetch API Call
Easiet way to use fetch with interceptros and awesome api endpoint declaration.
[bivrost/packages/fetch-api-call](https://github.com/tuchk4/bivrost/tree/master/packages/fetch-api-call)
## Bivrost
The main idea of Bivrost is grouping several API methods into data-sources.
[Bivrost full documentation and recipes](https://tuchk4.github.io/bivrost/)
## Installation
```
yarn add bivrost
```
## The gist
That’s it! Create api function for github api.
```js
import api from 'bivrost/http/api'
import fetchAdapter from 'bivrost-fetch-adapter';
const githubApi = api({
protocol: 'https:'
host: 'api.github.com',
adapter: fetchAdapter()
});
//define API method
const repositoryList = githubApi('GET /users/:user/repos'),
//call API method
repositoryList({ user: 'tuchk4' })
.then(repositories => console.log(repositories));
```
Create data source that contain few github api methods (get repositories list
and get repository info) and its invoke chain.
```js
import DataSource from 'bivrost/data/source';
import githubApi from './github-api';
import tcomb from 'tcomb';
class GihtubRepositories extends DataSource {
// define invoke method chain. Default chain is - ['api', 'process']
static steps = ['api', 'immutable'];
// "define "api" step
static api = {
repos: githubApi('GET /users/:user/repos'),
repoInfo: githubApi('GET /repos/:user/:repository'),
};
// step function will be executed for each method
static immutable = response => Immutable.fromJSON(response);
// define data source public methods that invokes steps methods
getRepositories(user) {
return this.invoke('repos', {
user,
});
}
getRepositoryInfo(user, repository) {
return this.invoke('repoInfo', {
user,
repository,
});
}
}
```
Extends GihtubRepositories and define username. Now all requests will be done
for facebook's github group.
```js
import GihtubRepositories from './github-repositories';
const FACEBOOK_GITHUB_ACCOUNT = 'facebook';
class FacebookRepositories extends GihtubRepositories {
getRepositories() {
return super.getRepositories(FACEBOOK_GITHUB_ACCOUNT);
}
getRepositoryInfo(repository) {
return super.getRepositoryInfo(FACEBOOK_GITHUB_ACCOUNT, repository);
}
}
```
### [Contributing](docs/contributing.md)
Project is open for new ideas and features:
* new adapters
* new api functions
* data source features
* feedback is very matter
---
## Docs
* [Basics](/docs/basics/README.md)
* [Api function](/docs/basics/api-function.md)
* [Adapter](/docs/basics/adapter.md)
* [Data source](/docs/basics/data-source.md)
* [Recipes](/docs/recipes/README.md)
* [Api enchantment](/docs/recipes/api-enchantment.md)
* [Generate DataSource invoke functions](/docs/recipes/data-source-auto-invoke.md)
* [Data source immutable output](/docs/recipes/data-source-immutable.md)
* [Data source type checking (tcomb)](/docs/recipes/data-source-type-checking.md)
* [CRUD Data source](/docs/recipes/generate-crud-methods.md)
* [File upload](/docs/recipes/file-upload.md)
* [Fixtures](/docs/recipes/fixtures.md)
* [Default api response](/docs/recipes/default-response.md)
* [Prepare request and process response](/docs/recipes/prepare-process.md)
* [Testing](/docs/testing.md)
* [Contributing](docs/contributing.md)
#### Adapters
* [Fetch adapter](https://github.com/tuchk4/bivrost/tree/master/packages/packages/bivrost-fetch-adapter)
* [Axios adapter](https://github.com/tuchk4/bivrost/tree/master/packages/packages/bivrost-axios-adapter)
* [Delay adapter](https://github.com/tuchk4/bivrost/tree/master/packages/packages/bivrost-delay-adapter)
* [Local storage adapter](https://github.com/tuchk4/bivrost/tree/master/packages/packages/bivrost-local-storage-adapter)
* [Save blob adapter adapter](https://github.com/tuchk4/bivrost/tree/master/packages/packages/bivrost-save-blob-adapter)