Skip to content

Commit aaffe37

Browse files
committed
update readme
1 parent 86fd920 commit aaffe37

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
### Create Project
66

77
```bash
8-
POST http://localhost:8000/projects HTTP/1.1
8+
POST {{api_url}}/projects HTTP/1.1
99
Content-Type: application/json
1010

1111
{
12-
"project_name": "frog-routes"
12+
"name": "frog-routes"
1313
}
1414
```
1515

@@ -28,21 +28,23 @@ Response body of a new project:
2828

2929
### Add routes to your project
3030

31+
A route is where you mock your HTTP response, using combination of "path",
32+
"verb", "content_type", and "response_body":
33+
3134
```bash
3235
POST http://localhost:8000/projects/{{pid}}/routes HTTP/1.1
3336
Content-Type: application/json
3437

3538
{
36-
path: "/users",
37-
verb: "DELETE",
38-
payload:
39-
{
40-
"firstName": "Pei",
41-
"lastName": "Wu"
42-
}
39+
"path": "/users",
40+
"verb": "DELETE",
41+
"content_type": "applicaton/json",
42+
"response_body": "{\"firstName\": \"Pei\", \"lastName\": \"Wu\"}"
4343
}
4444
```
4545

46+
(to be continued)
47+
4648
## TODOS
4749

4850
### Project

0 commit comments

Comments
 (0)