JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 19605
  • Score
    100M100P100Q155098F
  • License Apache-2.0

Mocks Server plugin providing an administration REST API

Package Exports

  • @mocks-server/plugin-admin-api
  • @mocks-server/plugin-admin-api/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mocks-server/plugin-admin-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mocks Server logo

Build Status Coverage Quality Gate Downloads Renovate License

Mocks Server Plugin Admin Api

Plugin for Mocks Server that provides a REST API allowing to interact with the server while it is running.

This is very useful when running E2E tests, because you can change the responses of the API mock simply with a HTTP request in the before method of your tests, for example.

A client for the administration api is also distributed as a separated package: @mocks-server/admin-api-client.

Usage

This plugin is included in the main distribution of the Mocks Server project, so you can refer to the official documentation website.

Options

  • plugins.adminApi.port (Number): Port for the administration REST API. Default is 3110.
  • plugins.adminApi.host (String): Host for the administration REST API. Default is 0.0.0.0 (Reachable to all IPv4 addresses on the local machine).
  • plugins.adminApi.https.enabled (Boolean): Enables the HTTPS protocol in the administration REST API
  • plugins.adminApi.https.cert (String): Path to the HTTPS certificate. Relative to the current process.cwd() or absolute.
  • plugins.adminApi.https.key (String): Path to the HTTPS certificate key. Relative to the current process.cwd() or absolute.

Read more about how to set options in Mocks Server here.

API resources

Available API resources are described in the OpenAPI specification provided by the API server itself at http://localhost:3110/docs/open-api.json once it is started.

Contributing

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