Miss any of our Open RFC calls?Watch the recordings here! »

fotch

1.0.3 • Public • Published

Fotch – In browser fake REST API for creative development purposes!

Motivation

When I code for fun, I need to have backend REST API to play with. Usually, I feel too lazy to create a dumb REST API. I have dream about a simple library that I could plug in the frontend with little effort and simulate and persist data somewhere. Then fotch was born.

How it works?

fotch monkey patch window.api and intercept all calls. When a matching call looks like a REST operation then fotch responde as you would expect. All data is stored in window.localStorage.

Installation

npm i fotch

Usage

import fotch from 'fotch'
 
fotch.start()

That's it! Seriously, just start using the fetch API as if there's a REST API. You can stop intercepting calls using fotch.stop().

▶︎ View demo on CodeSandbox

Examples

// Get a list of apples.
fetch('/apples')
 
// Get an apple by id.
fetch('/apples/1')
 
// Create an apple.
fetch('/apples', { method: 'post', data: JSON.stringify({ color: 'red' }) })
 
// Update an apple.
fetch('/apples/1', { method: 'put', data: JSON.stringify({ color: 'green' }) })
 
// Remove an apple.
fetch('/apples/1', { method: 'delete' })

Options

There's only one option that will allow to filter certain calls:

// Filter any call where its URL contains “/api/”.
fotch.start('/api/')

If you need more options then request it creating an issue.


Development

  1. Clone this repo.
  2. Install dependencies: npm i
  3. Create a PR.

Test

npm test

Releases

npm run release
npm run release:beta

Install

npm i fotch

DownloadsWeekly Downloads

3

Version

1.0.3

License

MIT

Unpacked Size

40.6 kB

Total Files

28

Last publish

Collaborators

  • avatar