redux-api-call

Redux utilities for API calls using fetch with automatic race-conditions elimination.

npm i -S redux-api-call

Detailed API Reference

Migration from v0 to v1

The goals

One declarative API to create reducers, action creators and selectors for JSON any API calls

Examples

1// EXAMPLE 1
2// this will create data selector and action creator for your components to use
3const todoListAPI = makeFetchAction(
4  'TODO_LIST',
5  (params) => ({ endpoint: `/api/v1/todos?page=${params.page}&limit=${params.limit}` })
6);
7
8// trigger fetch action
9store.dispatch(todoListAPI.actionCreator({ page: 1, limit: 10 }));
10
11// get the data
12const todos = todoListAPI.dataSelector(store.getState());
13
14// you can also use destructuring syntax for better readability
15const { actionCreator: fetchTodos, dataSelector: todosSelector } = makeFetchAction(/* ... */);
16
17// EXAMPLE 2
18// race-condition elimination:
19// if those commands are called in sequence
20// no matter how long each request takes,
21// page 2 and page 3 data will not have a chance to override page 4 data.
22store.dispatch(fetchTodos({ page: 2 });
23store.dispatch(fetchTodos({ page: 3 });
24store.dispatch(fetchTodos({ page: 4 });

Get Started

Steps:

1. install
2. add reducer
3. add middleware
4. declare api definitions

First, you need to install the redux-api-call using npm or yarn

1npm i -S redux-api-call
2
3// OR
4yarn add redux-api-call

Secondly, you need to add a reducer to your root reducer with a pathname is api_calls (In next releases, this name should be configurable, but for now, just use it)

1// rootReducer.js
2import { combineReducers } from 'redux';
3import { reducers as apiReducers } from 'redux-api-call';
4
5const rootReducer = combineReducers({
6  ...apiReducers,
7});

Then please import middleware from redux-api-call and put it to your redux middleware stack

1// configStore.js
2import { createStore, applyMiddleware } from 'redux';
3import { middleware as apiMiddleware } from 'redux-api-call';
4
5const middlewares = applyMiddleware(
6  apiMiddleware
7  // ... other middlewares (thunk, promise, etc.)
8);
9const store = createStore(rootReducer, {}, middlewares);

Most importantly, define your API. The simplest form only requires an endpoint

1// state.js
2import { makeFetchAction } from 'redux-api-call'
3import { createSelector } from 'reselect'
4import { flow, get, filter } from 'lodash/fp'
5
6export const todoAPI = makeFetchAction('FETCH_TODOS', () => ({ endpoint: '/api/v1/todos' });
7
8export const todosSelector = flow(todoAPI.dataSelector, get('todos'));
9export const completeTodosSelector = createSelector(todosSelector, filter(todo => todo.complete));
10export const incompleteTodosSelector = createSelector(todosSelector, filter(todo => !todo.complete));

And that's it. Now you have a bunch of action creators and selectors. You can use them anywhere you want. The following code is an example of using redux-api-call and react-redux

1// example usage with react
2// component.jsx
3import react from 'react';
4import { connect } from 'react-redux';
5import { todoAPI } from './state';
6
7// destructuring for better readability
8const {
9  fetchTodos,
10  isFetchingSelector,
11  completeTodosSelector,
12  incompleteTodosSelector,
13  errorSelector,
14  lastResponseSelector,
15} = todoAPI;
16
17const connectToRedux = connect(
18  state => ({
19    loading: isFetchingSelector(state),
20    error: errorSelector(state),
21    completeTodos: completeTodosSelector(state),
22    incompleteTodos: incompleteTodosSelector(state),
23    lastResponse: lastResponseSelector(state),
24  }),
25  {
26    fetchTodos,
27  }
28);
29
30class TodosComponent extends React.Component {
31  componentDidMount() {
32    // first fetch
33    this.props.fetchTodos();
34  }
35
36  render() {
37    const { loading, error, completeTodos, incompleteTodos } = this.props;
38
39    return <div>{/* ... your markup ...*/}</div>;
40  }
41}
42
43export default connectToRedux(TodosComponent);

API

Detailed API Reference

FAQ

1. Can I use this without react?

Yes, wherever you can use redux, you can use redux-api-call

2. Can I use this with jQuery's $.ajax?

Yes, redux-api-call comes with a default adapter that fetch data using HTML5 FetchAPI and try to parse the response as JSON text. If the response is not a valid JSON, it will fall back to raw text. Advanced topics like Customer Adapters will show you how to use virtually any kind of request agent, include raw XHR to axios.

3. My backend send XML instead of JSON, can I use this package?

Yes, advanced topics like Customer Adapters will show you how to add custom parser to your response. So your backend can send JSON, XML, or any custom content-type of your choice.

4. I need to add a header for authentication on every request, can I write it once and use it everywhere?

Yes, advanced topics like Customer Adapters will show you how to add any kind of interceptors to your outgoing request. You can even access to redux store anytime you want to receive data before sending to your backend.