serverless-offline-http-mock
v1.0.0
Published
This is a plugin for the serverless framework that provides the ability to create mock responses to HTTP(S) requests.
Downloads
2,383
Maintainers
Readme
serverless-offline-http-mock
Overview
This is a plugin for the serverless framework that provides the ability to create mock responses to HTTP(S) requests. This is useful when developing integration against an API spec that doesn't yet exist. This plugin uses nock to provide mock responses. It supports mock requests for:
- Local Invoke Lambda calls
- Serverless Offline API Gateway Lambda calls
- Serverless Appsync Offline data sources
Requirements
An existing serverless framework project.
Installation
npm install serverless-offline-http-mock
OR
yarn add serverless-offline-http-mock
Upgrade to v1.0.0
Please note that if you installed a version of this prior to v1.0.0, you will need to follow step #2 below and add a truthy serverless-offline-http-mock-enabled
value in order for your mocks to be loaded.
Usage
Within the
serverless.yml
file, enable the plugin by placing anserverless-offline-http-mock
entry in the plugins section. If using Serverless Offline, make sure it is placed above theserverless-offline
pluginCreate a
serverless-offline-http-mock-enabled
entry in thecustom
section with a truthy (true, 1, etc) or falsy value (false, 0, etc). You can also use environment variables (for example,${env:MOCK_ENABLED}
).Create a
serverless-offline-http-mock
entry in thecustom
section.For each host, create an entry containing hostname, a list of JS files to load, and an optional directory. See
serverless.yml
example below.In each JS file, export a function that accepts the nock library and hostname as arguments. Within that function, implement nock to handle the HTTP(S) requests. See
example.js
example below.
Example
serverless.yml:
...
custom:
serverless-offline-http-mock-enabled: 1
serverless-offline-http-mock:
- hostname: http://www.example.com
directory: 'mocks' # Optional
mocks:
- example.js
plugins:
- serverless-offline-http-mock # Note how this comes before serverless-offline
- serverless-offline
mocks/example.js:
const mocks = (nock, hostname) =>
nock(hostname)
.persist()
.get('/')
.reply(200, 'success!');
module.exports = mocks;
Development
yarn test