javierbrea

@mocks-server/plugin-admin-api

  "name": "@mocks-server/plugin-admin-api",

  "description": "Mocks Server plugin providing an administration REST API",

    "url": "https://github.com/mocks-server/main.git",

    "directory": "packages/plugin-admin-api"

  "homepage": "https://www.mocks-server.org",

    "@mocks-server/admin-api-paths": "4.0.0",

    "@mocks-server/admin-api-paths": "4.1.0",

  "readme": "<p align=\"center\"><a href=\"https://mocks-server.org\" target=\"_blank\" rel=\"noopener noreferrer\"><img width=\"120\" src=\"https://www.mocks-server.org/img/logo_120.png\" alt=\"Mocks Server logo\"></a></p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/mocks-server/main/actions?query=workflow%3Abuild+branch%3Amaster\"><img src=\"https://github.com/mocks-server/main/workflows/build/badge.svg?branch=master\" alt=\"Build Status\"></a>\n  <a href=\"https://codecov.io/gh/mocks-server/main\"><img src=\"https://codecov.io/gh/mocks-server/main/branch/master/graph/badge.svg?token=2S8ZR55AJV\" alt=\"Coverage\"></a>\n  <a href=\"https://sonarcloud.io/project/overview?id=mocks-server_main_plugin-admin-api\"><img src=\"https://sonarcloud.io/api/project_badges/measure?project=mocks-server_main_plugin-admin-api&metric=alert_status\" alt=\"Quality Gate\"></a>\n  <a href=\"https://www.npmjs.com/package/@mocks-server/plugin-admin-api\"><img src=\"https://img.shields.io/npm/dm/@mocks-server/plugin-admin-api.svg\" alt=\"Downloads\"></a>\n  <a href=\"https://renovatebot.com\"><img src=\"https://img.shields.io/badge/renovate-enabled-brightgreen.svg\" alt=\"Renovate\"></a>\n  <a href=\"https://github.com/mocks-server/main/blob/master/packages/plugin-admin-api/LICENSE\"><img src=\"https://img.shields.io/npm/l/@mocks-server/plugin-admin-api.svg\" alt=\"License\"></a>\n</p>\n\n---\n\n# Mocks Server Plugin Admin Api\n\nPlugin for [Mocks Server][website-url] that provides a REST API allowing to interact with the server while it is running.\n\nThis 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.\n\nA __client for the administration api__ is also distributed as a separated package: [@mocks-server/admin-api-client](https://www.npmjs.com/package/@mocks-server/admin-api-client).\n\n## Usage\n\nThis plugin is included in the main distribution of the Mocks Server project, so you can refer to the [official documentation website][website-url].\n\n## Options\n\n* __`plugins.adminApi.port`__ _(Number)_: Port for the administration REST API. Default is `3110`.\n* __`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).\n\nRead more about [how to set options in Mocks Server here](https://www.mocks-server.org/docs/configuration/how-to-change-settings).\n\n## API resources\n\nAvailable API resources are described in the OpenAPI specification provided by the API server itself at [http://localhost:3110/docs/open-api.json](http://localhost:3110/docs/open-api.json) once it is started.\n\n## Contributing\n\nContributors are welcome.\nPlease read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md).\n\n[website-url]: https://www.mocks-server.org/docs/integrations/rest-api\n[logo-url]: https://www.mocks-server.org/img/logo_120.png\n"

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

const { DEFAULT_HOST, DEFAULT_PORT } = require("@mocks-server/admin-api-paths");

const { ALL_HOSTS, serverUrl } = require("../common/helpers");

const { serverUrl } = require("../common/helpers");

const START_ERROR_MESSAGE = "Error starting server";

    description: "Port number for the admin API server to be listening at",

    description: "Host for the admin API server",

  constructor({ alerts, logger, config, onChangeOptions }) {

    [this._portOption, this._hostOption] = this._config.addOptions(OPTIONS);

    this._onChangeOptions = onChangeOptions;

    this._optionsChanged = this._optionsChanged.bind(this);

    this._startServer = this._startServer.bind(this);

    this._portOption.onChange(this._optionsChanged);

    this._hostOption.onChange(this._optionsChanged);

    this._server = http.createServer(this._express);

    this._express.use(logRequest({ logger: this._logger }));

      this._express.use(router.path, router.router);

    this._express.use(notFound({ logger: this._logger }));

    this._express.use(errorHandler({ logger: this._logger }));

    this._alerts.remove(SERVER_ALERT_ID);

    this._server.on("error", (error) => {

      this._alerts.set(SERVER_ALERT_ID, "Server error", error);

      callback(new Error("Server timed out trying to start"));

        this._alerts.set(START_ALERT_ID, START_ERROR_MESSAGE, error);

        this._logger.info(`Server started and listening at ${serverUrl({ host, port })}`);

        this._alerts.remove(START_ALERT_ID);

      this._logger.debug("Server is already starting, returning same promise");

		{
		"name": "@mocks-server/plugin-admin-api",
		"version": "3.3.0",
		"version": "3.3.1",
		"description": "Mocks Server plugin providing an administration REST API",
		@@ -36,3 +36,3 @@ "keywords": [
		"@hapi/boom": "9.1.4",
		"@mocks-server/admin-api-paths": "4.0.0",
		"@mocks-server/admin-api-paths": "4.1.0",
		"swagger-ui-dist": "4.13.0",
		@@ -45,3 +45,3 @@ "body-parser": "1.20.0",
		"devDependencies": {
		"@mocks-server/core": "3.7.0"
		"@mocks-server/core": "3.8.0"
		},
		@@ -48,0 +48,0 @@ "engines": {

		@@ -15,2 +15,4 @@ /*
		const express = require("express");
		const { DEFAULT_HOST, DEFAULT_PORT } = require("@mocks-server/admin-api-paths");

		const {
		@@ -25,3 +27,3 @@ addRequestId,

		const { ALL_HOSTS, serverUrl } = require("../common/helpers");
		const { serverUrl } = require("../common/helpers");

		@@ -37,3 +39,3 @@ const START_ALERT_ID = "start";
		type: "number",
		default: 3110,
		default: DEFAULT_PORT,
		},
		@@ -44,3 +46,3 @@ {
		type: "string",
		default: ALL_HOSTS,
		default: DEFAULT_HOST,
		},
		@@ -47,0 +49,0 @@ ];

Improved metrics

Dependency changes