Contacts API

Welcome to the demo contacts API! This is a small set of RESTful JSON API endpoints that implement an editable address book. There is no authentication - use /api/contacts/reset to reset the service. Paylods and responses should use Content-type: application/json.

Contact model:

{
  id: number;
  name: string;
  email: string | null;
  phone: string | null;
  notes: string | null;
}

Contact example:

{
  id: 2,
  name: "Mike Kaylor",
  email: "kaylor@gmail.com",
  phone: "415-250-1311",
  notes: "Used to live in California, moved to Oregon"
}

Endpoints

GET /api/contacts

Retrieve all of the contacts in the address book as a JSON array.

curl -X GET https://address-book-api-demo.herokuapp.com/api/contacts

POST /api/contacts

Create a new contact by providing a name and/or optional fields in the JSON POST body.

curl -X POST -d '{"name":"Howard", "notes":"Great guy."}' https://address-book-api-demo.herokuapp.com/api/contacts

GET /api/contacts/:id

Retrieve one contact from the address book.

curl -X GET https://address-book-api-demo.herokuapp.com/api/contacts/2

PUT /api/contacts/:id

Modify a contact by providing any or all of the contact fields in the JSON POST body.

curl -X PUT -d '{"notes":"LOL"}' https://address-book-api-demo.herokuapp.com/api/contacts/2

DELETE /api/contacts/:id

Delete a contact, note that this returns an empty 200 response upon success.

curl -X DELETE https://address-book-api-demo.herokuapp.com/api/contacts/10

POST /api/contacts/reset

Reset your entire contact book back to the original demo set. Useful to wipe the entire service and re-test.

curl -X POST https://address-book-api-demo.herokuapp.com/api/contacts/reset