Skip to content

Commit 623f10e

Browse files
committed
Move server docs
1 parent f11871c commit 623f10e

File tree

2 files changed

+74
-65
lines changed

2 files changed

+74
-65
lines changed

README.md

Lines changed: 1 addition & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -10,70 +10,6 @@ registering request matcher and responses from the client side.
1010

1111
*BIG FAT WARNING:* software like this is inherently insecure. Only use in trusted, controlled environments.
1212

13-
## The client side API
13+
## Usage
1414

1515
Read the [docs](doc/index.md)
16-
17-
## The server
18-
19-
### Setting up expectation for request recording
20-
```
21-
POST /_expectation
22-
{
23-
response (required): serialized Symfony response
24-
matcher (optional): serialized list of closures
25-
limiter (optional): serialized closure that limits the validity of the expectation
26-
}
27-
```
28-
29-
### Accessing latest recorded request
30-
```
31-
GET /_request/latest
32-
Content-Type: text/plain
33-
34-
RECORDED REQUEST
35-
```
36-
37-
### Accessing recorded request by index
38-
```
39-
GET /_request/{{index}}
40-
Content-Type: text/plain
41-
42-
RECORDED REQUEST
43-
```
44-
45-
### Shift recorded request
46-
```
47-
GET /_request/shift
48-
Content-Type: text/plain
49-
50-
RECORDED REQUEST
51-
```
52-
53-
### Pop recorded request
54-
```
55-
GET /_request/pop
56-
Content-Type: text/plain
57-
58-
RECORDED REQUEST
59-
```
60-
61-
### Deleting expectations
62-
```
63-
DELETE /_expectation
64-
```
65-
66-
### Deleting recorded requests
67-
```
68-
DELETE /_request
69-
```
70-
71-
### Deleting everything
72-
```
73-
DELETE /_all
74-
```
75-
76-
### Introspection
77-
```
78-
GET /_me
79-
```

doc/server.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## The server
2+
3+
Overview of the internal server functionality
4+
5+
### Setting up expectation for request recording
6+
```
7+
POST /_expectation
8+
{
9+
response (required): serialized Symfony response
10+
matcher (optional): serialized list of closures
11+
limiter (optional): serialized closure that limits the validity of the expectation
12+
}
13+
```
14+
15+
### Accessing latest recorded request
16+
```
17+
GET /_request/latest
18+
Content-Type: text/plain
19+
20+
RECORDED REQUEST
21+
```
22+
23+
### Accessing recorded request by index
24+
```
25+
GET /_request/{{index}}
26+
Content-Type: text/plain
27+
28+
RECORDED REQUEST
29+
```
30+
31+
### Shift recorded request
32+
```
33+
GET /_request/shift
34+
Content-Type: text/plain
35+
36+
RECORDED REQUEST
37+
```
38+
39+
### Pop recorded request
40+
```
41+
GET /_request/pop
42+
Content-Type: text/plain
43+
44+
RECORDED REQUEST
45+
```
46+
47+
### Count recorded requests
48+
```
49+
GET /_request/count
50+
Content-Type: text/plain
51+
52+
REQUEST COUNT
53+
```
54+
55+
### Deleting expectations
56+
```
57+
DELETE /_expectation
58+
```
59+
60+
### Deleting recorded requests
61+
```
62+
DELETE /_request
63+
```
64+
65+
### Deleting everything
66+
```
67+
DELETE /_all
68+
```
69+
70+
### Introspection
71+
```
72+
GET /_me
73+
```

0 commit comments

Comments
 (0)