{
  "name": "@mocks-server/plugin-admin-api",
  "version": "4.0.1",
  "description": "Mocks Server plugin providing an administration REST API",
  "keywords": [
    "mocks-server-plugin",
    "administration",
    "admin",
    "api",
    "rest",
    "testing",
    "development"
  ],
  "author": "Javier Brea",
  "license": "Apache-2.0",
  "repository": {
    "type": "git",
    "url": "https://github.com/mocks-server/main.git",
    "directory": "packages/plugin-admin-api"
  },
  "homepage": "https://www.mocks-server.org",
  "publishConfig": {
    "access": "public"
  },
  "files": [
    "src",
    "static",
    "index.js"
  ],
  "main": "index.js",
  "peerDependencies": {
    "@mocks-server/core": ">=4.0.0 <5.x"
  },
  "dependencies": {
    "@hapi/boom": "9.1.4",
    "@mocks-server/admin-api-paths": "5.0.0",
    "body-parser": "1.20.2",
    "cors": "2.8.5",
    "express": "4.18.2",
    "express-request-id": "1.4.1",
    "swagger-ui-dist": "4.14.0"
  },
  "devDependencies": {
    "@mocks-server/core": "4.0.2"
  },
  "engines": {
    "node": ">=14.0.0"
  },
  "scripts": {
    "test:unit": "jest --runInBand"
  },
  "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* __`plugins.adminApi.https.enabled`__ _(Boolean)_: Enables the HTTPS protocol in the administration REST API\n* __`plugins.adminApi.https.cert`__ _(String)_: Path to the HTTPS certificate. Relative to the current `process.cwd()` or absolute.\n* __`plugins.adminApi.https.key`__ _(String)_: Path to the HTTPS certificate key. Relative to the current `process.cwd()` or absolute.\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"
}