File tree Expand file tree Collapse file tree 1 file changed +28
-3
lines changed Expand file tree Collapse file tree 1 file changed +28
-3
lines changed Original file line number Diff line number Diff line change @@ -10,7 +10,32 @@ For architecture details, see [ARCHITECTURE](./ARCHITECTURE.md)
1010
1111## Usage
1212
13- If you'd like to try out how it works, add an OpenAPIv3 Specification to the [ ` specs ` ] ( ./specs ) folder (the spec will be read upon startup) or do a
13+ ### Docker
14+
15+ To try it out quickly:
16+
17+ ```
18+ $ docker pull floriank/mimicry
19+ ```
20+
21+ and a
22+
23+ ```
24+ $ docker run -p 8080:8080 floriank/mimicry
25+ ```
26+
27+ ### Inspecting running mimic servers
28+
29+ By default, servers are available under the special ` __mimicry ` path:
30+
31+ ```
32+ $ curl --header "Content-Type: application/json" \
33+ http://localhost:4000/__mimicry
34+ ```
35+
36+ ### Creating a new mimic server
37+
38+ If you'd like to try out how it works, post a _ valid_ OpenAPIv3 to create a mock server:
1439
1540```
1641$ curl --header "Content-Type: application/json" \
@@ -19,8 +44,6 @@ $ curl --header "Content-Type: application/json" \
1944 http://localhost:4000/__mimicry
2045```
2146
22- to get and ad hoc server.
23-
2447Following up with a
2548
2649```
@@ -31,6 +54,8 @@ $ curl --header "X-Mimicry-Host: https://my.production.api.info" \
3154
3255should return you the specification.
3356
57+
58+
3459## Development
3560
3661The project comes with a small [ ` docker-compose ` ] ( https://docs.docker.com/compose/ ) setup. You can use ` make ` to get started:
You can’t perform that action at this time.
0 commit comments