Socket
Socket
Sign inDemoInstall

@mocks-server/plugin-admin-api

Package Overview
Dependencies
286
Maintainers
1
Versions
35
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mocks-server/plugin-admin-api

Mocks Server plugin providing an administration REST API


Version published
Maintainers
1
Weekly downloads
22,584
increased by2.1%

Weekly downloads

Readme

Source

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.

Keywords

FAQs

Last updated on 29 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc