getting-started.md

Getting started

First thing, you need to do, is to define the spec of your API calls.
You could use any level of nesting in the spec object.

import { createApi } from 'redux-wave';

const api = createApi({
  read: {
    path: '/repos/:owner/:repo',
    method: 'GET'
  },
  edit: {
    path: '/repos/:owner/:repo',
    method: 'PATCH'
  }
}, {
  endpoint: 'https://api.github.com'
});

export default api;

After, api instance is ready, we need to create reducer and middleware using it.

import { createStore, applyMiddleware, combineReducers } from 'redux';
import { createApiMiddleware, createApiReducer } from 'redux-wave';
import api from './api';

const store = createStore(
  combineReducers({
    api: createApiReducer(api)
  }),
  applyMiddleware(
    createApiMiddleware(api)
  )
);

export default store;

Next step is to dispatch request actions, to initiate data fetching for the specific api.
After data will be fetched, we can use select helper, to get neccessary data from the state.

import store from './store';
import api from './api';

store.dispatch(api.read.actions.request({
  params: {
    owner: '1ven',
    repo: 'redux-wave'
  }
}));

store.subscribe(() => {
  const state = store.getState();

  console.group('fetching repo:')
  console.log('data', api.read.select('data')(state));
  console.log('is fetching?', api.read.select('isFetching')(state));
  console.groupEnd();
});