Skip to content

Latest commit

 

History

History
201 lines (159 loc) · 3.82 KB

config.md

File metadata and controls

201 lines (159 loc) · 3.82 KB
Raw

Mock configuration

api folder

# mock api: api.target.com/api/login

|- mock
  |- api.target.com
    |- api
      |- login
        |- login success
          |- data.js # data.js defined res data
        |- login fail
          |- data.js
        |- it takes too long
          |- data.js
          |- http.js # http can set res header, http status code, and control time cose

restful api

# mock api: api.target.com/users/:id

|- mock
  |- api.target.com
    |- users
      |- :id
        |- res user data
          |- data.js

attention: in Windows, you need to replace : with %3A, replace * with %2A

# windows mock api: api.target.com/users/:id

|- mock
  |- api.target.com
    |- users
      |- %3Aid
        |- res user data
          |- data.js # data文件定义响应的数据

Wildcard

# mock api: api.target.com/(.*)

|- mock
  |- api.target.com
    |- (.*)
      |- res data
        |- data.js

data & http

Each interface mock data configuration directory, you can export the data to be responded by data.js, and http.js is used to define the http response behavior.

// http default configuration
{
  delay: 0.2, // request time consuming
  status: 200, // http status code
  header: { // http response header
    'Content-Type': 'application/json; charset=UTF-8',
    Connection: 'Close',
    'Access-Control-Allow-Origin': '*'
  }
}

Response data

// mock/****/data.js
module.exports = {
  code: '0',
  msg: 'ok'
};

Response html

// mock/****/data.js
module.exports = `
<!DOCTYPE html>
<html lang="en">
<head>
  <title>Document</title>
</head>
<body>return html</body>
</html>
`;

// mock/****/http.js
module.exports = {
  header: {
    'Content-Type': 'text/html; charset=UTF-8'
  }
};

Time consuming api

If you want to simulate the control interface processing time, such as too long time, the front-end request timeout, etc., can be configured in http.js

// mock/****/data.js
module.exports = {
  code: '0',
  msg: 'response after 2s'
};

// mock/****/http.js
module.exports = {
  delay: 2
};

Http status code

If you need the analog interface to return an http status code other than 200, you can also specify it in http.js

// mock/****/data.js
module.exports = 'Not Found';

// mock/****/http.js
module.exports = {
  status: 404
};

Function

If you want to simulate the actual behavior of the interface, such as parameter checking, or use mock.js to generate random data returns, etc.

You can execute js logic by exporting the function in data.js, which is called koa#ctx

// mock/****/data.js
module.exports = (ctx) => {
  // parameter check
  // response data generation
  // .....

  return {
    data: {}, // response data
    header: {}, // optional return, same as http.js#header
    status: 200, // optional return, same as http.js#status
    delay: 0.2, // optional return, same as http.js#delay
  }
}

// Asynchronous logic can use the async method, or return a promise
module.exports = async (ctx) => {
  // ...

  return {
    data: {}
  };
}

Note: When relying on external npm libraries in the mock configuration (such as relying on [mockjs] (https://github.com/nuysoft/Mock) to generate data), please perform dependency installation outside the mock configuration directory, such as mock The parent directory of the directory

|- proj
  |- mock
    |- ... #mock configuration
  |- node_modules
  |- package.json
// mock/****/data.js
const xxx = require('xxx'); // npm dependency
module.exports = {};

self handle ctx

const send = require('koa-send');
const static = '/path/to/static/path';

module.exports = async (ctx) => {
  await send(ctx, ctx.path, {
    root: static
  });

  return {
    selfHandle: true
  };
};