Skip to content

Commit 46b7c15

Browse files
committed
docs: adds CLI run examples for mock plugins.
1 parent 18bebab commit 46b7c15

File tree

6 files changed

+24
-8
lines changed

6 files changed

+24
-8
lines changed

docs/hbase_plugin.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ For working examples, see:
4242

4343
Let's assume your configuration is in a folder named `config`.
4444

45+
CLI example:
46+
47+
imposter up ./config
48+
4549
Docker example:
4650

4751
docker run -ti -p 8080:8080 \
@@ -51,7 +55,7 @@ Docker example:
5155

5256
Standalone Java example:
5357

54-
java -jar distro/hbase/build/libs/imposter-all.jar \
58+
java -jar distro/all/build/libs/imposter-all.jar \
5559
--configDir ./config \
5660
--serverUrl http://localhost:8080
5761

docs/openapi_plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Let's assume your configuration is in the directory: `examples/openapi/simple`.
110110

111111
CLI example:
112112

113-
imposter up -p 8080 ./examples/openapi/simple
113+
imposter up ./examples/openapi/simple
114114

115115
Docker example:
116116

@@ -120,7 +120,7 @@ Docker example:
120120

121121
Java JAR example:
122122

123-
java -jar distro/openapi/build/libs/imposter.jar \
123+
java -jar distro/core/build/libs/imposter-core.jar \
124124
--configDir ./examples/openapi/simple
125125

126126
This starts a mock server using the OpenAPI plugin. Responses are served based on the OpenAPI specification `petstore.yaml`.

docs/rest_plugin.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ In this example, we are using a static response file (`example-data.json`) conta
4040
4141
Let's assume your configuration is in the directory: `examples/rest/simple`.
4242

43+
CLI example:
44+
45+
imposter up ./examples/rest/simple
46+
4347
Docker example:
4448

4549
docker run --rm -ti -p 8080:8080 \
@@ -48,7 +52,7 @@ Docker example:
4852

4953
Standalone Java example:
5054

51-
java -jar distro/rest/build/libs/imposter.jar \
55+
java -jar distro/core/build/libs/imposter-core.jar \
5256
--configDir ./examples/rest/simple
5357

5458
Send an HTTP request to the `/example` path defined in the configuration file to see the example response:

docs/sfdc_plugin.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ For working examples, see:
4545

4646
Let's assume your configuration is in a folder named `config`.
4747

48+
CLI example:
49+
50+
imposter up ./config --engine-type docker-all
51+
4852
Docker example:
4953

5054
docker run -ti -p 8080:8080 \
@@ -54,7 +58,7 @@ Docker example:
5458

5559
Standalone Java example:
5660

57-
java -jar distro/sfdc/build/libs/imposter-all.jar \
61+
java -jar distro/all/build/libs/imposter-all.jar \
5862
--configDir ./config \
5963
--serverUrl http://localhost:8080
6064

docs/soap_plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,17 @@ Let's assume your configuration is in the directory: `examples/soap/simple`. Her
102102

103103
CLI example:
104104

105-
imposter up -p 8080 ./examples/soap/simple
105+
imposter up ./examples/soap/simple
106106

107107
Docker example:
108108

109109
docker run --rm -ti -p 8080:8080 \
110110
-v $PWD/examples/soap/simple:/opt/imposter/config \
111-
outofcoffee/imposter-all
111+
outofcoffee/imposter
112112

113113
Java JAR example:
114114

115-
java -jar distro/soap/build/libs/imposter-all.jar \
115+
java -jar distro/core/build/libs/imposter-core.jar \
116116
--configDir ./examples/soap/simple
117117

118118
This starts a mock server using the SOAP plugin. Responses are served based on the WSDL file and its referenced XSD file `schema.xsd`.

docs/wiremock_plugin.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ For working examples, see [WireMock examples](https://github.com/imposter-projec
4141

4242
Let's assume your configuration is in a folder named `wiremock-simple`.
4343

44+
CLI example:
45+
46+
imposter up ./wiremock-simple --engine-type docker-all
47+
4448
Docker example:
4549

4650
docker run -ti -p 8080:8080 \

0 commit comments

Comments
 (0)