Mocks Server plugin providing an administration REST API. 

Mocks Server plugin providing an administration REST API

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",

  "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.

} = require("@mocks-server/admin-api-paths");

const CustomRoutesVariants = require("./CustomRoutesVariants");

const { readCollectionAndModelRouter } = require("./support/routers");

const { version } = require("../package.json");

  constructor({ logger, config, mock, alerts, coreVersion }) {

      logger: this._logger.namespace("config"),

      logger: this._logger.namespace("alerts"),

                message: alert.error.message,

                stack: alert.error.stack,

      logger: this._logger.namespace("about"),

    this._customRoutesVariantsApi = new CustomRoutesVariants({

      logger: this._logger.namespace("customRouteVariants"),

      getRouteVariants: () => mock.routes.plainVariants,

    this._collectionsApi = readCollectionAndModelRouter({

      getItems: () => mock.collections.plain,

      logger: this._logger.namespace("collections"),

        method: route.method.toLowerCase(),

    this._routesApi = readCollectionAndModelRouter({

      getItems: () => mock.routes.plain.map(parseRoute),

      logger: this._logger.namespace("routes"),

    this._routeVariantsApi = readCollectionAndModelRouter({

      getItems: () => mock.routes.plainVariants,

      logger: this._logger.namespace("routeVariants"),

    this._router.use(ABOUT, this._aboutApi.router);

    this._router.use(CONFIG, this._configApi.router);

    this._router.use(ALERTS, this._alertsApi.router);

    this._router.use(COLLECTIONS, this._collectionsApi);

    this._router.use(ROUTES, this._routesApi);

    this._router.use(VARIANTS, this._routeVariantsApi);

    this._router.use(CUSTOM_ROUTE_VARIANTS, this._customRoutesVariantsApi.router);

      "This API is provided by the Mocks Server's plugin [@mocks-server/plugin-admin-api](https://www.npmjs.com/package/@mocks-server/plugin-admin-api). It allows to administrate the mock server while it is running, allowing to change its configuration, etc.",

      url: "https://www.apache.org/licenses/LICENSE-2.0.html",

    description: "Find out more about Mocks Server administration API",

    url: "https://www.mocks-server.org/docs/integrations/rest-api",

      description: "Server and plugins info",

      description: "Access to Mocks Server configuration",

        url: "https://www.mocks-server.org/docs/configuration/options",

      description: "Access to Mocks Server alerts",

        url: "https://www.mocks-server.org/docs/api/javascript/alerts",

      description: "Operations about the API mock",

        url: "https://www.mocks-server.org/docs/usage/basics",

        summary: "Returns info about server and plugins",

        description: "Use it to get current versions of Mocks Server packages",

            description: "successful operation",

                  $ref: "#/components/schemas/About",

        summary: "Returns current configuration",

        description: "Current configuration object from all config namespaces",

                  $ref: "#/components/schemas/Config",

                            email: "foo@foo.com",

                        id: "get-user:2",

                        route: "get-user",

        summary: "Find route variant by ID",

          "Returns a single [route variant](https://www.mocks-server.org/docs/usage/variants)",

            description: "ID of the variant to return",

                  $ref: "#/components/schemas/Variant",

                          email: "foo@foo.com",

            description: "Variant not found",

                  $ref: "#/components/schemas/Error",

          "Returns available collections. Find out more about [collections](https://www.mocks-server.org/docs/usage/collections)",

                  $ref: "#/components/schemas/Collections",

                    summary: "Two collections",

                        definedRoutes: ["get-users", "get-user:1"],

                        routes: ["get-user:1"],

                        definedRoutes: ["get-user:2"],

                        routes: ["get-users", "get-user:2"],

        summary: "Find collection by ID",

          "Returns a single [collection](https://www.mocks-server.org/docs/usage/collections)",

            description: "ID of collection to return",

                  $ref: "#/components/schemas/Collection",

                    summary: "Collection",

                      definedRoutes: ["get-users", "get-user:1"],

                      routes: ["get-user:1"],

            description: "When true, using this variant disables the route",

              "Approached preview of the response that will be sent when the route variant is used. Null when it is not possible to have an idea of the response",

              "Route delay. When defined, it overrides the route delay and the global routes delay setting. If it is null, the route delay is ignored and the global delay setting is used",

          $ref: "#/components/schemas/Variant",

            description: "Collection id",

            description: "Id of other collection from which this one extends",

              "Ids of the route variants applied to this collection. It takes into account routes from the base collections",

              $ref: "#/components/schemas/RouteVariantId",

            description: "Ids of the route variants explicitly defined for the collection",

          $ref: "#/components/schemas/Collection",

        description: "Route and variant id joined with ':'",

        enum: ["get", "post", "patch", "delete", "put", "options", "head", "trace"],

          "Ids of the route variants that are currently used instead of those defined in the current collection",

          $ref: "#/components/schemas/RouteVariantId",

            description: "Response status code",

            description: "Error description",

            description: "Error message",

		{
		"name": "@mocks-server/plugin-admin-api",
		"version": "3.2.0",
		"version": "3.3.0",
		"description": "Mocks Server plugin providing an administration REST API",
		@@ -32,3 +32,3 @@ "keywords": [
		"peerDependencies": {
		"@mocks-server/core": ">=3.6.0 <4.x"
		"@mocks-server/core": ">=3.7.0 <4.x"
		},
		@@ -45,3 +45,3 @@ "dependencies": {
		"devDependencies": {
		"@mocks-server/core": "3.6.0"
		"@mocks-server/core": "3.7.0"
		},
		@@ -48,0 +48,0 @@ "engines": {

		@@ -82,6 +82,3 @@ /*
		const parseRoute = (route) => {
		return {
		...route,
		method: route.method.toLowerCase(),
		};
		return route;
		};
		@@ -88,0 +85,0 @@

		@@ -383,2 +383,3 @@ const {
		type: "json",
		disabled: false,
		preview: {
		@@ -396,2 +397,3 @@ body: {
		type: "json",
		disabled: false,
		preview: {
		@@ -446,2 +448,3 @@ body: {
		type: "json",
		disabled: false,
		preview: {
		@@ -762,2 +765,6 @@ body: {
		},
		disabled: {
		type: "boolean",
		description: "When true, using this variant disables the route",
		},
		preview: {
		@@ -764,0 +771,0 @@ type: "object",

Fixed alerts

Improved metrics