Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maksim-chekrishov/redux-rest-adapter
REST adapter for redux
https://github.com/maksim-chekrishov/redux-rest-adapter
axios react redux redux-rest rest rest-api ssr
Last synced: about 2 months ago
JSON representation
REST adapter for redux
- Host: GitHub
- URL: https://github.com/maksim-chekrishov/redux-rest-adapter
- Owner: maksim-chekrishov
- Created: 2016-12-12T15:51:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T10:57:37.000Z (almost 7 years ago)
- Last Synced: 2024-10-29T01:16:01.323Z (2 months ago)
- Topics: axios, react, redux, redux-rest, rest, rest-api, ssr
- Language: JavaScript
- Size: 143 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# redux-rest-adapter
[](https://npmjs.org/package/redux-rest-adapter)
[](https://codeclimate.com/github/maksim-chekrishov/redux-rest-adapter)
[](https://codeclimate.com/github/maksim-chekrishov/redux-rest-adapter/coverage)
redux-rest-adapter is a tool for easy connection your REST api with redux store.
Compatible with [json.api specification](http://jsonapi.org/)
## Main points
- Write **code** instead of reducers and actions for trivial data operations.
## Changelog
Starts from v2.0.0 redux-rest-adapter based on
[axios](https://www.npmjs.com/package/axios) and
[promise-middleware](https://www.npmjs.com/package/promise-middleware)
for easy access to promises and better experience with isomorphic app.
[Versions 1.x.x](https://raw.githubusercontent.com/maksim-chekrishov/redux-rest-adapter/master/readme-src/readme-1v.md)
### short-example.js
```js
import EntityApi, {promiseMiddleware} from 'redux-rest-adapter';
import {createStore, applyMiddleware, combineReducers} from 'redux';
const tagsApi = new EntityApi({
entityName: 'TAG',
endpointUrl: 'api/v2/tags'
});
const apiReducer = combineReducers({
TAG: tagsApi.configureReducer()
});
const store = createStore(
combineReducers({
api: apiReducer
}),
{},
applyMiddleware(promiseMiddleware())
);
store.dispatch(tagsApi.actions.load()).then(()=> {
console.log(store.getState().api.TAG.data); // [{id:1, name:'tag1'}, {id:2, name:'tag2'}];
})
```
## Setup
### your/known-entities-api.js
```js
import EntityApi from 'redux-rest-adapter';
export const KnownEntitiesUrls = {
NEWS_TAGS: 'news-tags',
NEWS_TAG_FOR_EDIT: 'news-tags',
//..
};
export default _.mapValues(KnownEntitiesUrls, (url, name) => new EntityApi({
entityName: name,
endpointUrl: 'api/v2/' + url
}));
```
### your/api-reducer.js
```js
import knownEntitiesApi from 'your/known-entities-api';
// Ability to extend default api reducers
const apiReducersExtensions = {
NEWS_TAGS: tagsReducer
}
const apiReducers = _.mapValues(knownEntitiesApi, (api, key) => api.configureReducer(apiReducersExtensions[key]));
export default combineReducers(apiReducers);
```
### your/index-reducer.js
```js
import apiReducer from 'your/api-reducer';
export default combineReducers({
api: apiReducer
//..
});
```
### your/configure-store.js
```js
import indexReducer from 'your/index-reducer';
import {promiseMiddleware} from 'redux-rest-adapter';
//..
export default function configureStore(initialState) {
return createStore(
indexReducer,
initialState,
applyMiddleware(promiseMiddleware())
);
}
```
### your/entities-actions.js
```js
import knownEntitiesApi from 'your/known-entities-api';
export default _.mapValues(knownEntitiesApi, entityApi => entityApi.actions);
```
## Adapter is ready
## Usage
### Actions
```js
import entitesActions from 'your/entities-actions';
dispatch(entitesActions.NEWS_TAG.load()); // GET: api/v2/news-tags
dispatch(entitesActions.NEWS_TAG.load(1)); // GET: api/v2/news-tags/1
// --- NOTE: HTTP methods for create and update operations can be configured
dispatch(entitesActions.NEWS_TAG.update(1, {name: 'new tag'})); // PATCH: api/v2/news-tags/1
dispatch(entitesActions.NEWS_TAG.create({name: 'new tag'})); // POST: api/v2/news-tags
dispatch(entitesActions.NEWS_TAG.remove(1)); // DELETE: api/v2/news-tags/1
// --- Silent methods for changing store without sync with backend
dispatch(entitesActions.NEWS_TAG.set({name: 'new tag'})); // set new data
dispatch(entitesActions.NEWS_TAG.reset()); // reset to initial state
```
### React component example
```js
import entitesActions from 'your/entities-actions';
class TagsComponent extends Component {
componentWillMount() {
this.props.loadList();
}
//..
componentWillUnmount() {
this.props.resetEntryForEdit();
}
onTagFormSubmit = ()=> {
const data = this.props.tagForEdit;
if (data.id) {
this.props.updateTag(data.id, data);
} else {
this.props.createTag(data);
}
}
render() {
return (
this.props.pending ?
:
{/*...*/}
);
}
}
const mapStateToProps = (state) => ({
list: state.api.NEWS_TAGS.data || [],
pending: state.api.NEWS_TAGS._pending,
tagForEdit: state.api.NEWS_TAG_FOR_EDIT.data || {}
});
const mapDispatchToProps = {
createTag: entitiesActions.NEWS_TAG_FOR_EDIT.create,
updateTag: entitiesActions.NEWS_TAG_FOR_EDIT.update,
resetEntryForEdit: entitiesActions.NEWS_TAG_FOR_EDIT.reset,
loadList: entitiesActions.NEWS_TAGS.load
};
const TagsContainer = connect(mapStateToProps, mapDispatchToProps)(TagsComponent);
export {TagsComponent, TagsContainer};
```
## Configuration
### EntityApi constructor options
Name | Type | Default | Description
--- | --- | --- | ---
`entityName` | `String` | *Required.* will be used for naming state and actionTypes.
`endpointUrl` | `String | *Required.* endpointUrl
`reducersBuilderCustom` | `Object`| `reducersBuilderDefault` | Customer can redefine interface of reducers-builder.js
`axiosConfig` | `Object`| `{}` | [axios config](https://github.com/mzabriskie/axios#request-config)
`resourceKey` | `String`| `'data'` | Name of data property key at response object
`idKey` | `String`| `'id'` | Name of id property key at response data object. Required for CRUD reducer extensions
`restHttpMethods` | `Object`| `{create:'post', update:'patch'}` | Customer can change HTTP methods used for create and update actions
## TODO
Example of generated list reducer (basic CRUD operations)
### See also
[redux-localstorage-adapter](https://www.npmjs.com/package/redux-localstorage-adapter)