Suggestions on adding 'mock' attributes

[caohaijiang]

I am sorry, my English is very poor, but still love you this project. I am in the help of Google translation, and strive to establish communication with you. I am currently using this project and intend to recommend more people to use it. Here are my suggestions:

`
const { apiServer } = {
url: 'http://x.x.x.x/api',
mockUrl: 'http://x.x.x.x/api' // API services created using json-server
}
const API = createAPI(resources, middleware, API_URL, fetchOptions);
.....
const user ={
user: {
namespace: 'users/',
mock: true, // hope to add a 'mock' attribute here,
methods: {
get: ( ) => ({ path: '' }),
add: (data) => ({path:''},{options:{
method:'POST',
body:JSON.stringify(data),
}}),
}
}
}

export default user
`
readme:
mock = true: Connecting real API resources
mock = false: Connecting mock API resources

benefit:
This advantage is obvious, can help developers in the debugging process, more efficient

[Blackheart340]

@caohaijiang Hey, we glad you are using our project.
Why can't you create other instance of API for work with mock API?
For example:

const API = createAPI(resources, middleware, API_URL, fetchOptions);
const mockAPI = createAPI(resources, middleware, MOCK_API_URL, fetchOptions);

[TimeRaider]

@Blackheart340
I can see the appeal of using a single API object in your application, gradually swapping mocked implementations for the real ones and not having to change your app's code.

@caohaijiang
My suggestion would be writing custom middleware with a list of methods that should be intercepted and return mock data for them.

Since resourceId and method are available for you in middleware, you can do this (primitive implementation):

const mockAPIData = {
    user: {
      get: ({ id }) => ({ id: , name: 'David' })
   }
}
export default next => async(options, params, resourceId, method) {
  if (mockAPI[resourceId] && mockAPI[resourceId][method]) {
    return await Promise.resolve(mockAPI[resourceId][method](params))
  }
  return await next();
}

@caohaijiang let me know if it works for you

[caohaijiang]

In the file 'middleware', how to get 'API / mockAPI' object?

api.js

const API = createAPI(resources, middleware, API_URL, fetchOptions);
const mockAPI = createAPI(resources, middleware, MOCK_URL, fetchOptions);

middleware.js

const mock = next => async (middlewareOptions, apiCallParams, resource, method) => {
   if (mockAPI[resource] && mockAPI[resource][method]) {  //error: Could not find mockAPI
    return await Promise.resolve(mockAPI[resource][method](params))
  }
  return await next();
};

[caohaijiang]

oh, @Blackheart340 , I know what you think. But in doing so:

1. import { Api, mockApi } form 'api.js'
2. mockApi.user.get || Api.user.get
   If the production deployment, you need a lot of changes.

---

If, according to my advice, This can be used: Api.user.get( {}, { log:true, mock:true })
According to the system environment variables,
Env=develop: mock effective, debug log valid;
Env=prod: mock invalid, debug log invalid;

Wouldn't it be better? I have just started to learn, the results are not high, has not been able to modify their own code to achieve, therefore, very much hope that developers can upgrade to support this feature

[caohaijiang]

Thank you and your friend for help, the problem has been solved.
I think, you modify the source code, will use more elegant.

apis/user.js

const user ={
    user: {
        namespace: 'users/',
        methods: { get: ( ) => ({ path: '' }), }
    }
}

export default user

---

apis/index.js

import { assign } from 'lodash'
import user from './user'

export const resources = assign( {} ,
    user, 
)

export const fetchOptions = { ... }

---

api.js

import createAPI from 'unity-api';
import middleware from './utils/middleware' ;
import { resources, fetchOptions } from 'apis'

const { API_URL } = require(`config/${ENV}.json`);
const API = createAPI(resources, middleware, API_URL, fetchOptions);

export default API;

---

middleware.js

import createAPI from 'unity-api';
import { resources, fetchOptions } from 'apis'

const mock = next => async (middlewareOptions, apiCallParams, resource, method) => {
    const { mock } = middlewareOptions;
    if ( mock ) { 
        return await Promise.resolve( mockAPI[resource][method](apiCallParams)  )
     }

    return await next();
};

const logger = next => async (middlewareOptions, apiCallParams, resource, method) => {
};

const fit = next => async (middlewareOptions, apiCallParams, resource, method) => {
};

const middleware = [  logger, mock,fit ]

const { MOCK_URL } = require(`config/${ENV}.json`);
const mockAPI = createAPI(resources, middleware, MOCK_URL, fetchOptions);

export default  middleware