Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gernest committed Dec 5, 2015
1 parent 57c1cb7 commit f3cfb72
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,25 @@ I f your post request is submitted you are good to ask for the response with fak

So, every GET call to `/api/test` will return the api response with fake data.

# Routes
Apidemic server has only three http routes

### /
This is the home path. It only renders information about the apidemic server

### /register
This is where you register endpoints. You POST the annotated sample json here. The request body should be a json object of signature.

```json
{
"endpoint":"my_endpoint",
"payload": { ANNOTATED__SAMPLE_JSON_GOES_HERE },
}
```

#### /api/{REGISTERED_ENDPOINT_GOES_HERE}
Every GET request on this route will render a fake json object for the sample registered in this endpoint

# Tags
Apidemic uses tags to annotate what kind of fake data to generate and also control different requrements of fake data.

Expand Down

0 comments on commit f3cfb72

Please sign in to comment.