@Mockoon/serverless

Mockoon's Serverless package provides an easy way to run Mockoon's mock APIs in cloud functions and serverless environments: AWS Lambda, GCP Functions, Firebase Functions, etc.

The Serverless package supports the same features as the main application and CLI (with some limitations, see below): templating system, proxy mode, route response rules, etc.

Using this package

$3

``sh-session
$ npm install @mockoon/serverless
`

$3

The Serverless package needs a Mockoon Environment object loaded from a data file.
You are responsible for loading this data file (from a URL, S3, etc.) and providing the object to the class constructor (see below).

In the examples below, we will be loading the data file as if it was located next to your function's main file.

$3

This package exposes a single MockoonServerless class. To create a new RequestListener (an Express application), use the following code:

`javascript
const mockoon = require('@mockoon/serverless');

// Load the Mockoon Environment object
const mockEnv = require('./datafile.json');

const app = new mockoon.MockoonServerless(mockEnv);

exports.handler = app;
`

For vendor-specific code, see the sections below.

$3

To use Mockoon Serverless in an AWS Lambda, you can use the following code:

`javascript
const mockoon = require('@mockoon/serverless');

// Load the Mockoon Environment object
const mockEnv = require('./datafile.json');

const mockoonServerless = new mockoon.MockoonServerless(mockEnv);

module.exports.handler = mockoonServerless.awsHandler();
`

@mockoon/serverless is using the serverless-http package to wrap Mockoon's Express.js API.

$3

To use Mockoon Serverless in a Firebase Function, you can use the following code:

`javascript
const { onRequest } = require('firebase-functions/v2/https');
const mockoon = require('@mockoon/serverless');

// Load the Mockoon Environment object
const mockEnv = require('./datafile.json');

const app = new mockoon.MockoonServerless(mockEnv).firebaseApp();

exports.app = onRequest(app);
`

Since Firebase Functions uses GCP Functions underhood, a slightly different approach can be used with the functions-framework-nodejs:

`javascript
const functions = require('@google-cloud/functions-framework');
const mockoon = require('@mockoon/serverless');

// Load the Mockoon Environment object
const mockEnv = require('./datafile.json');

const app = new mockoon.MockoonServerless(mockEnv).firebaseApp();

functions.http('app', app);
`

$3

To use Mockoon Serverless with Netlify's serverless functions, first create a new Netlify function with the following code:

`javascript
const mockoon = require('@mockoon/serverless');

// Load the Mockoon Environment object
const mockEnv = require('./datafile.json');

const mockoonServerless = new mockoon.MockoonServerless(mockEnv);

exports.handler = mockoonServerless.netlifyHandler();
`

If you're not sure how to create a Netlify function, please read their official documentation.

Then, you will need to setup a redirect to direct requests to the mock API. A prefix like api is frequently used to distinguish between the requests targeting hosted websites, from requests targeting the API. Netlify will forward the full path to the running Mockoon serverless function which means that you need the same prefix in your mock configuration.
To add this redirection in your netlify.toml you have two possibilities:

`toml
[[redirects]]
force = true
from = "/api/*"
status = 200
to = "/.netlify/functions/{NAME_OF_YOUR_FUNCTION}/api/:splat"
`

or

`toml
[[redirects]]
force = true
from = "/api/*"
status = 200
to = "/.netlify/functions/{NAME_OF_YOUR_FUNCTION}"
`

After deploying to Netlify, any request starting with /api/* (e.g. https://APP_NAME.netlify.app/api/endpoint) would match the corresponding route (e.g. /api/endpoint) in your Mockoon config. You can also test locally using the Netlify CLI.

Options

The MockoonServerless class accepts an optional options object as a second parameter. The following options are available:

| Option name | Type | Default value | Description |
| --------------------- | ---------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| logTransaction | boolean | false | Enable full transaction logging (see below). |
| disabledRoutes | string[] | [] | Disable route(s) by UUID or keyword present in the route's path (do not include a leading slash) or keyword present in a folder name (see below). Use ['*'] to disable all routes. |
| fakerOptions.locale | string | [] | Faker locale (e.g. 'en', 'en_GB', etc. For supported locales, see below.) |
| fakerOptions.seed | number | [] | Number for the Faker.js seed (e.g. 1234) |
| envVarsPrefix | string | MOCKOON_ | Environment variables prefix. Pass an empty string to disable it. |
| enableAdminApi | boolean | true | Enable (default) or disable the Admin API. |
| disableTls | boolean | false | Disable TLS. TLS configuration is part of the environment configuration (more info: https://mockoon.com/docs/latest/server-configuration/serving-over-tls/). |
| maxTransactionLogs | number | 100 | Maximum number of transaction logs to keep in memory for retrieval via the admin API (default: 100). |
| enableRandomLatency | boolean | false | Randomize global and responses latencies between 0 and the specified value (default: false). |

Example:

`javascript
const mockoonServerless = new mockoon.MockoonServerless(mockEnv, {
logTransaction: true,
// disable all routes containing 'users' in their path, and the route with UUID '0999df54-7d57-407e-9325-c18d97fea729'
disabledRoutes: ['users', '0999df54-7d57-407e-9325-c18d97fea729'],
// or disable all routes
// disabledRoutes: ['*'],
fakerOptions: {
locale: 'en_GB',
seed: 1234
},
envVarsPrefix: 'CUSTOM_PREFIX_',
enableAdminApi: false,
disableTls: true,
enableRandomLatency: false
});
`

#### Admin API

Each running mock API has an admin API enabled by default and available at /mockoon-admin/. This API allows you to interact with the running mock API, retrieve logs, and more. You can disable the admin API with the enableAdminApi option.

> 💡 To learn more about the admin API, check the documentation.

#### Faker.js options

- Locale: If not provided, Faker.js will use the default locale: en. For a list of currently supported locales, you can check the supported locales list in Mockoon's commons library. You can also check Faker.js locales list for more information (⚠️ Some locales may not yet be implemented in Mockoon).
- Seed: If not provided, Faker.js will not use a seed. By providing a seed value, you can generate repeatable sequences of fake data. Using seeding will not always generate the same value but rather a predictable sequence.

Logging

Mockoon's Serverless package logs all server events (start, stop, proxy creation, transactions, etc.) to the console. You can also enable full transaction logging to log all requests and responses (see below).

$3

When using the logTransaction option, logs will contain the full transaction (request and response) with the same information you can see in the desktop application "Logs" tab.

Example:

`json
{
"app": "mockoon-server",
"level": "info",
"message": "Transaction recorded",
"timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
"environmentName": "Demo API",
"environmentUUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"requestMethod": "GET",
"requestPath": "/test",
"requestProxied": false,
"responseStatus": 200,
"transaction": {
"proxied": false,
"request": {
"body": "{}",
"headers": [{ "key": "accept", "value": "/" }],
"method": "GET",
"params": [],
"query": "",
"queryParams": {},
"route": "/test",
"urlPath": "/test"
},
"response": {
"body": "{}",
"headers": [
{ "key": "content-type", "value": "application/json; charset=utf-8" }
],
"statusCode": 200,
"statusMessage": "OK"
},
"routeResponseUUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"routeUUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
`

To enable full transaction logging, set logTransaction to true in the constructor options:

`javascript
const mockoonServerless = new mockoon.MockoonServerless(mockEnv, {
logTransaction: true
});
`

The transaction model can be found here.

Disabling routes

You can disable routes at runtime by providing their UUIDs or a keyword present in the route's path (do not include a leading slash). You can also disable all the routes present in a folder (including subfolders) by adding a keyword present in a folder name.

This is the counterpart of the "Toggle route" feature in the desktop application (right-click on a route -> "Toggle route").

For example, to disable all routes in a folder named folder1, and all routes having "users" in their paths, you can provide the following array ['folder1', 'users'].

To disable all routes, you can pass an array containing a single string with a wildcard: ['*']`.

Serverless package limitations

Due to the stateless nature of cloud functions, some of Mockoon's features will not work:

- the data buckets will not be persisting and be regenerated during each call.
- the rules based on the request number will not work as this counter will be reset during each call.

Mockoon's documentation

You will find Mockoon's documentation on the official website.

Support us!

Mockoon is proudly independent and open-source, maintained without external funding. We rely on both sponsorships and Mockoon Cloud subscriptions to keep improving the project and building new features. A big thank you to the companies below for supporting our work and helping us grow (and all the sponsors who helped this project over time!):

$3

       

$3

$3

If you'd like to support Mockoon as well, you can become a sponsor or subscribe to Mockoon Cloud, every contribution helps keep the project alive and evolving. Thank you!

Subscribe to Mockoon Cloud

With advanced features for solo developers and teams, Mockoon Cloud supercharges your API development:

- ☁️ cloud deployments
- 🔄️ data synchronization and real-time collaboration
- 🤖 AI powered API mocking
- 📃 Access to dozens of ready-to-use JSON templates.
- 💬 Priority support and training.

Upgrade today and take your API development to the next level.

Support/feedback

You can discuss all things related to Mockoon's CLI, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository.

Contributing

If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.

Please also take a look at our Code of Conduct.

Roadmap

If you want to know what will be coming in the next release you can check the global Roadmap or subscribe to our newsletter.