README

mockforme npm package can be used to intercept APIs and return mock responses created by you on your personalized dashboard on mockforme

Mockforme Documentation

How to set up?

Prerequisites

• Register and login on https://www.mockforme.com
• Generate client access token from: https://dashboard.mockforme.com/user/token

Installation

Install the package using npm or yarn:

npm install mockforme --save-dev
OR
yarn add mockforme -D

How to use?

CLIENT SIDE INTEGRATION

• Import the package in your code for client side

  import { mockforme } from 'mockforme';

• Initialize the SDK using Access Token (Generate access token here)

  mockforme().run();

  Note: MockForMe client initialisation doesn't required access token, you can enter the token using MockForMe widget

  

• You can also access mockforme object in your browser from window object:

  console.log(window.mockforme);

  And initialize it directly from window:

  window.mockforme().run();

• You can also directly use mockforme through script file using jsdelivr CDN.

  <script src="https://cdn.jsdelivr.net/npm/mockforme@latest/dist/mockforme.client.umd.js"></script>
  
  <script>
  	console.log(window.mockforme);
  	window.mockforme().run();
  </script>

SERVER SIDE INTEGRATION

• Import the package in your code for server side

  import { mockforme } from 'mockforme/server';

• Initialize the SDK using Access Token (Generate access token here)

  mockforme('ACCESS_TOKEN').run();

Example

https://codesandbox.io/p/sandbox/wizardly-gagarin-smlf7z

About Us

https://www.mockforme.com is one of the many ways to mock your APIs. But it's SIMPLE.

• Easy to mock APIs: Run your flows easily; minimize dev and testing effort
• User friendly: Simple and easy to use; rich and powerful features
• Easy Integration: The easiest integration ever; works like a charm

Who do I talk to?

For queries, email us: [email protected]