Skip to content

Commit ff01a69

Browse files
committed
Minor readme tweaks
1 parent d7963b5 commit ff01a69

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

wiremock/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
WireMock on LocalStack
2-
========================
1+
# WireMock on LocalStack
32

43
This repo contains a [LocalStack Extension](https://github.com/localstack/localstack-extensions) that facilitates developing [WireMock](https://wiremock.org)-based applications locally.
54

65
The extension supports two modes:
6+
77
- **OSS WireMock**: Uses the open-source `wiremock/wiremock` image (default)
88
- **WireMock Runner**: Uses `wiremock/wiremock-runner` with WireMock Cloud integration (requires API token)
99

1010
## Prerequisites
1111

12-
* Docker
13-
* LocalStack Pro (free trial available)
14-
* `localstack` CLI
15-
* `make`
16-
* [WireMock CLI](https://docs.wiremock.io/cli/overview) (for WireMock Runner mode)
12+
- Docker
13+
- LocalStack Pro (free trial available)
14+
- `localstack` CLI
15+
- `make`
16+
- [WireMock CLI](https://docs.wiremock.io/cli/overview) (for WireMock Runner mode)
1717

1818
## Install from GitHub repository
1919

@@ -25,7 +25,7 @@ localstack extensions install "git+https://github.com/localstack/localstack-exte
2525

2626
## Install local development version
2727

28-
To install the extension into localstack in developer mode, you will need Python 3.11, and create a virtual environment in the extensions project.
28+
To install the extension into LocalStack in developer mode, you will need Python 3.11, and create a virtual environment in the extensions project.
2929

3030
In the newly generated project, simply run
3131

@@ -68,6 +68,7 @@ curl -X POST -H "Content-Type: application/json" \
6868
### WireMock Runner Mode (Cloud Integration)
6969

7070
To use WireMock Runner with WireMock Cloud, you need:
71+
7172
1. A WireMock Cloud API token
7273
2. A `.wiremock` directory with your mock API configuration
7374

@@ -104,14 +105,16 @@ localstack start
104105
```
105106

106107
**Environment Variables:**
108+
107109
- `WIREMOCK_API_TOKEN`: Your WireMock Cloud API token (required for runner mode)
108110
- `WIREMOCK_CONFIG_DIR`: Path to the directory containing your `.wiremock` folder (required for runner mode)
109111

110112
Note: When using the LocalStack CLI, prefix environment variables with `LOCALSTACK_` to forward them to the container.
111113

112114
## Sample Application
113115

114-
See the `sample-app/` directory for a complete example using Terraform that demonstrates:
116+
See the `sample-app-runner/` directory for a complete example using Terraform that demonstrates:
117+
115118
- Creating an API Gateway
116119
- Lambda function that calls WireMock stubs
117120
- Integration testing with mocked external APIs

0 commit comments

Comments
 (0)