This package provides an API client for administrating Mocks Server through HTTP requests to the Admin API plugin.

Requests to the Mocks Server administration API are made using cross-fetch, which makes this package compatible with browsers and Node.js environments, but, if you are going to build a browser application, you'll probably prefer to use the @mocks-server/admin-api-client-data-provider package, which uses Data Provider, and works well with Redux, React, etc.

npm install --save @mocks-server/admin-api-client

The UMD build is also available on unpkg. When UMD package is loaded, it creates a mocksServerAdminApiClient global object containing all methods and classes.

<script src="https://unpkg.com/@mocks-server/admin-api-paths/dist/index.umd.js"></script>
<script src="https://unpkg.com/@mocks-server/admin-api-client/dist/index.umd.js"></script>

NOTE: The umd distribution is bundled with the cross-fetch dependency, but it requires the @mocks-server/admin-api-paths dependency to be added separately.

Import and create a new AdminApiClient class. All methods described in the Api return Promises when executed (except the configClient method):

import { AdminApiClient } from "@mocks-server/admin-api-client";

const example = async () => {
  const adminApiClient = new AdminApiClient();

  const { version } = await adminApiClient.readAbout();
  console.log(`Current Admin API plugin version is ${versions.adminApi}`);

  const currentConfig = await adminApiClient.readConfig();
  console.log("Current Mocks Server config is", JSON.stringify(currentConfig));

  await adminApiClient.updateConfig({
    mock: {
      collections: {
        selected: "user-super-admin"
      },
      routes: {
        delay: 1000
      },
    },
  });
  console.log("Collection and delay changed");
};

example();

Returns an instance containing next methods:

• readAbout() - Returns info about the Admin API plugin, such as current version.
• readConfig() - Returns current configuration.
• updateConfig(configObject) - Updates Mocks Server configuration. A configuration object has to be provided. Read the Mocks Server configuration docs for further info.
• readAlerts() - Returns array of current alerts.
• readAlert(alertId) - Returns an specific alert.
• readCollections() - Returns available collections.
• readCollection(id) - Returns a collection by ID.
• readRoutes() - Returns available routes.
• readRoute(id) - Returns a route by ID.
• readVariants() - Returns available route variants.
• readVariant(id) - Returns a route variant by ID.
• readCustomRouteVariants() - Returns current custom route variants of the current collection.
• useRouteVariant(id) - Sets a custom route variant to be used by current collection.
• restoreRouteVariants() - Restore route variants to those defined in current collection.
• configClient(clientConfig) - Changes the client configuration.
  • clientConfig <Object> - It should be an object containing any of next properties:
    • port - <Number> - Changes the client port. Default is 3110.
    • host - <String> - Changes the client host. Default is 127.0.0.1.
    • https - <Boolean> - If true, changes the client protocol to "https". Default is false.
    • agent - <http.Agent | https.Agent> - A custom agent can be provided. This is useful in Node.js environments in order to make able to request to https APIs with self-signed certificates (see example below).

By default, clients are configured to request to http://127.0.0.1:3110/api, based in the default options of Mocks Server Plugin Admin API

You can change the host, port and protocol of the administration API using the configClient method:

import { AdminApiClient } from "@mocks-server/admin-api-client";

const apiClient = new AdminApiClient();
apiClient.configClient({
  host: "localhost",
  port: 3500,
  https: true,
});

When the administration API is started with https enabled using a self-signed certificate, and the client is used in Node.js, a custom agent can be provided in order to avoid unauthorized rejections:

import https from "https";
import { AdminApiClient } from "@mocks-server/admin-api-client";

const httpsAgent = new https.Agent({
  rejectUnauthorized: false,
});

const apiClient = new AdminApiClient();
apiClient.configClient({
  host: "localhost",
  port: 3500,
  https: true,
  agent: httpsAgent
});

Contributors are welcome. Please read the contributing guidelines and code of conduct.