# Wiremock NPM [![NPM](https://img.shields.io/npm/v/wiremock.svg?style=flat-square) ](https://www.npmjs.com/package/wiremock) This is [Wiremock Standalone](http://wiremock.org/docs/running-standalone/) wrapped [inside an NPM package](https://github.com/tomasbjerre/npm-java-runner). It relies only on dependencies found in NPM. See: http://wiremock.org/docs/running-standalone/ ## Example - Command line It can be used as a command line tool like this: ```bash npx wiremock ``` ## Example - Mock API in frontend app This example is in the repo in [`example-mock-api-with-express`](/example-mock-api-with-express). It starts a server with [ExpressJS](https://www.npmjs.com/package/expressjs) and delegates to a frontend and an API. When running `npm run serve` it will start this setup: ``` http://localhost:8080/ | | |---[/api/*]-> http://localhost:8081/ | \ \-[*]------> http://localhost:8082/ ``` So that: - `http://localhost:8080/api/example` Will serve the API with `wiremock`. - `http://localhost:8080/whatever` Will serve the frontend. This can be a Vue app or whatever. ## Command line arguments Available command line arguments `npx wiremock --help`: ```sh Option Description ------ ----------- --admin-api-basic-auth Require HTTP Basic authentication for admin API calls with the supplied credentials in username:password format --admin-api-require-https Require HTTPS to be used to access the admin API --allow-proxy-targets Comma separated list of IP addresses, IP ranges (hyphenated) and domain name wildcards that can be proxied to/recorded from. Is evaluated before the list of denied addresses. --async-response-enabled Enable asynchronous response (default: false) --async-response-threads Number of asynchronous response threads (default: 10) --bind-address The IP to listen connections --ca-keystore Path to an alternative keystore containing a Certificate Authority private key & certificate for generating certificates when proxying HTTPS. Password is assumed to be "password" if not specified. (default: /home/bjerre/.wiremock/ca- keystore.jks) --ca-keystore-password Password for the alternative CA keystore. (default: password) --ca-keystore-type Type of the alternative CA keystore (jks or pkcs12). (default: jks) --container-threads The number of container threads --deny-proxy-targets Comma separated list of IP addresses, IP ranges (hyphenated) and domain name wildcards that cannot be proxied to/recorded from. Is evaluated after the list of allowed addresses. --disable-banner Disable print banner logo --disable-extensions-scanning Prevent extensions from being scanned and loaded from the classpath --disable-gzip Disable gzipping of request and response bodies --disable-http Disable the default HTTP listener. --disable-optimize-xml-factories- Whether to disable optimize XML loading factories loading or not. --disable-request-logging Disable logging of stub requests and responses to the notifier. Useful when performance testing. --disable-response-templating Disable processing of responses with Handlebars templates --disable-strict-http-headers Whether to disable strict HTTP header handling of Jetty or not. --enable-browser-proxying Allow wiremock to be set as a browser's proxy server --enable-stub-cors Enable automatic sending of CORS headers with stub responses. --extensions Matching and/or response transformer extension class names, comma separated. --filename-template Add filename template --global-response-templating Preprocess all responses with Handlebars templates --help Print this message --https-keystore Path to an alternative keystore for HTTPS. Password is assumed to be "password" if not specified. (default: jar:file:/home/bjerre/. npm/_npx/7a7511ad0e1cd094/node_modules/wiremock/build/wiremock- standalone-3.3.0.jar!/keystore) --https-port If this option is present WireMock will enable HTTPS on the specified port --https-require-client-cert Make the server require a trusted client certificate to enable a connection --https-truststore Path to an alternative truststore for HTTPS client certificates. Must have a password of "password". --jetty-accept-queue-size The size of Jetty's accept queue size --jetty-acceptor-threads Number of Jetty acceptor threads --jetty-header-buffer-size Deprecated. The size of Jetty's buffer for request headers --jetty-header-request-size The size of Jetty's buffer for request headers --jetty-header-response-size The size of Jetty's buffer for response headers --jetty-idle-timeout Idle timeout in milliseconds for Jetty connections --jetty-stop-timeout Timeout in milliseconds for Jetty to stop --key-manager-password Key manager password for use with the alternative keystore. (default: password) --keystore-password Password for the alternative keystore. (default: password) --keystore-type The HTTPS keystore type. (default: JKS) --load-resources-from-classpath Specifies path on the classpath for storing recordings (parent for mappings and __files folders) --local-response-templating Preprocess selected responses with Handlebars templates --logged-response-body-size-limit Maximum size for response bodies stored in the request journal beyond which truncation will be applied --match-headers Enable request header matching when recording through a proxy --max-request-journal-entries Set maximum number of entries in request journal (if enabled) to discard old entries if the log becomes too large. Default: no discard --max-template-cache-entries [String] The maximum number of response template fragments that can be cached. Only has any effect when templating is enabled. Defaults to no limit. --no-request-journal Disable the request journal (to avoid heap growth when running wiremock for long periods without reset) --permitted-system-keys [String] A list of case-insensitive regular expressions for names of permitted system properties and environment vars. Only has any effect when templating is enabled. Defaults to no limit. --port The port number for the server to listen on (default: 8080). 0 for dynamic port selection. --preserve-host-header Will transfer the original host header from the client to the proxied service --print-all-network-traffic Print all raw incoming and outgoing network traffic to console --proxy-all Will create a proxy mapping for /* to the specified URL --proxy-pass-through Flag to control browser proxy pass through --proxy-timeout Timeout in milliseconds for requests to proxy --proxy-via Specifies a proxy server to use when routing proxy mapped requests --record-mappings Enable recording of all (non-admin) requests as mapping files --root-dir Specifies path for storing recordings (parent for mappings and __files folders) (default: .) --timeout The default global timeout. --trust-all-proxy-targets Trust all certificates presented by origins when browser proxying --trust-proxy-target Trust any certificate presented by this origin when browser proxying --truststore-password Password for the trust store (default: password) --truststore-type The HTTPS trust store type (default: JKS) --use-chunked-encoding Whether to use Transfer-Encoding: chunked in responses. Can be set to always, never or body_file. (default: always) --verbose Enable verbose logging to stdout ```

	Stars	Issues	Version	Updated	Created
@storybook/components	82,821	1,857	8.0.9	5 days ago	7 years ago
json-server			1.0.0-alpha.23	3 months ago	10 years ago
moxios	1,416	21	0.4.0	7 years ago	8 years ago
sb	82,821	1,857	8.0.9	5 days ago	10 years ago
wiremock	14	0	3.5.4	4 days ago	5 years ago

@storybook/components vs json-server vs moxios vs sb vs wiremock

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past