diff --git a/src/content/docs/docs/grpc.mdx b/src/content/docs/docs/grpc.mdx index da1e6722..6a4319cb 100644 --- a/src/content/docs/docs/grpc.mdx +++ b/src/content/docs/docs/grpc.mdx @@ -24,7 +24,7 @@ Using these, it converts incoming messages to JSON before passing them to WireMo It also converts JSON responses back into proto messages so that all of WireMock's response definition features including templating can be used. -WireMock and gRPC scheman +WireMock and gRPC scheman The extension also adds a Java DSL that works with the Java classes generated by `protoc`, while also providing a more gRPC idiomatic way of defining stubs. diff --git a/src/content/docs/docs/mock-api-templates/usage.mdx b/src/content/docs/docs/mock-api-templates/usage.mdx deleted file mode 100644 index b546c060..00000000 --- a/src/content/docs/docs/mock-api-templates/usage.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "Using Mock API Templates" ---- - -import VCode from '../../../../components/VCode.astro'; -import { VERSIONS } from '../../../../config/versions.ts'; - - - -This guide explains how to run an API template after you've downloaded the JSON file from the library page. - -## WireMock standalone JAR - -1. Create a folder called `mappings` if one doesn't already exist in the directory containing the standalone JAR file. -2. Copy the downloaded JSON file into the `mappings` directory then e.g. -3. The JSON will be automatically loaded at startup, via the command line - - -{`java -jar wiremock-jre8-standalone-${VERSIONS.WIREMOCK_STABLE}.jar`} - - -See [this page](../../standalone/) for general details on running WireMock standalone. - -## In WireMock Docker - -1. Create a folder with a subfolder inside called `mappings`. -2. Copy the JSON file into the `mappings` folder. -3. Start the Docker container, mounting the parent folder e.g. assuming the current directory contains `mappings`: - - -{`docker run -it --rm \\ - -p 8080:8080 \\ - --name wiremock \\ - -v $PWD:/home/wiremock \\ - wiremock/wiremock:${VERSIONS.WIREMOCK_STABLE}`} - - -See [this page](../../standalone/) for general details on running WireMock Docker. - -## Plain Java - -If you're running WireMock embedded in a Java program or test suite -you can place the JSON file in a folder called `mappings` -then set its parent as the WireMock server's root at startup. - -```java -WireMockServer wm = - new WireMockServer(wireMockConfig() - .withRootDirectory("path/to/root") // The parent folder of mappings - ); -``` - -See [this](../../java-usage/) for general details on running WireMock in embedded Java. - -## JUnit - -To do the same thing using the JUnit Jupiter extension: - -```java -@RegisterExtension - static WireMockExtension wm1 = WireMockExtension.newInstance() - .options(wireMockConfig().withRootDirectory("path/to/root")) - .build(); -``` - -See [this](../../junit-jupiter/) for general details on running WireMock with JUnit 5+ Jupiter. - -## Pushing to a remotely running WireMock server - -The mock API JSON can be pushed to a remotely running WireMock server via its [Admin API](../../standalone/admin-api-reference/). - -For instance if the WireMock server is running on `wiremock.dev.mycompany.com` port 8080, you can POST the JSON file to it e.g. - -```bash -curl -v -d@mockapi.json http://wiremock.dev.mycompany.com:8080/__admin/mappings/import -``` diff --git a/src/content/docs/docs/proxying.mdx b/src/content/docs/docs/proxying.mdx index 287defb2..afcb6715 100644 --- a/src/content/docs/docs/proxying.mdx +++ b/src/content/docs/docs/proxying.mdx @@ -226,7 +226,7 @@ To configure your browser to proxy via WireMock, first start WireMock with brows Then open your browser's proxy settings and point them to the running server: -Firefox proxy screenshot +Firefox proxy screenshot After that, you can configure stubs as described in [Running Standalone](../standalone/java-jar/#configuring-wiremock-using-the-java-client) and then browse to a website. Any resources fetched whose requests are matched by stubs you have configured will be overridden by the stub's response. diff --git a/src/content/docs/docs/record-playback.mdx b/src/content/docs/docs/record-playback.mdx index 2aad97cb..7f0c2aa2 100644 --- a/src/content/docs/docs/record-playback.mdx +++ b/src/content/docs/docs/record-playback.mdx @@ -30,7 +30,7 @@ Once that's running visit the recorder UI page at [http://localhost:8080/\_\_adm -Recorder UI +Recorder UI Enter the URL you wish to record from in the target URL field and click the Record button. You can use `http://examples.wiremockapi.cloud` to try it out. diff --git a/src/content/docs/docs/verifying.mdx b/src/content/docs/docs/verifying.mdx index e09e052e..abee1e8a 100644 --- a/src/content/docs/docs/verifying.mdx +++ b/src/content/docs/docs/verifying.mdx @@ -27,13 +27,13 @@ Like stubbing, verification also uses WireMock's [Request Matching](../request-m When verifying via the Java API all failed verifications will result in a `VerificationException` being thrown. -Verification exception +Verification exception The message text in the exception is formatted to enable IntelliJ's failure comparison view: -Comparison failure +Comparison failure ## Verifying in Java