https://github.com/chungchi300/redux-api-middleware-addon
https://github.com/chungchi300/redux-api-middleware-addon
redux-api-middleware
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chungchi300/redux-api-middleware-addon
- Owner: chungchi300
- License: mit
- Created: 2017-11-05T11:59:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T08:50:55.000Z (about 7 years ago)
- Last Synced: 2025-03-15T18:49:49.991Z (3 months ago)
- Topics: redux-api-middleware
- Language: JavaScript
- Size: 128 KB
- Stars: 33
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Features
1. **Predictable and Ready-to-go api reducer to handle common network result for Rest API** ,E.g **Domain,Network,Api** Reducer
2. Support **swagger.json**,**documentation as code**
3. Support **file upload**
## Installation
```
npm install redux-api-middleware-addon --save
```
## Example
### Swagger definitions
https://github.com/chungchi300/redux-api-middleware-addon/blob/master/src/common/swagger.js
### Code Usage
```
import SWAGGER from 'swagger.js';
store.dispatch(Action.setProtocol('https'));
store.dispatch(Action.setSwagger(SWAGGER));
store.dispatch(
Action.setHeaders({
// 'X-Token': 'base64TokenForApiCall',
Accept: 'application/json',
['Content-Type']: 'application/json',
})
);
store
.dispatch(
Action.request(
'/pet/findByStatus',
{
method: 'get',
data: { status: 'available' },
subst: null,
},
BASIC
)
)
.then(res => console.log(res));
store
.dispatch(
Action.request(
'/pet',
{
method: 'post',
data: {
name: 'ronald',
id: 3,
photoUrls: [
'https://upload.wikimedia.org/wikipedia/commons/thumb/2/26/Letter_d.svg/1200px-Letter_d.svg.png',
],
},
},
BASIC
)
)
.then(res => console.log(res));
store
.dispatch(
Action.request(
'/pet/findByStatus',
{
method: 'get',
data: { status: 'available' },
subst: null,
},
entity('PETS_BY_ID')
)
)
.then(res => console.log(res));
```
### Result
## Components
### Action
1. SET_SWAGGER
2. Request
3. SET_HEADER(default empty)
4. SET_PROTOCOL(default http)
### helpers
1. Generate Basic types
2. Generate Get Entity types
//TODO
Generate update,delete,create which help network reducer record which api has api result that failed
### Reducer
1. network (reducer,where is network result located)
2. domain (reducer,where is CRUD resource result located)
3. api (reducer,where is the api located)