Skip to content

shaisachs/GiftIdeas

Repository files navigation

Gift Ideas API

An API which you can use to make note of gift ideas throughout the year - to make buying gifts much easier. Check it out on Mashape!

Basic CRUD functionality on all resources is supported. Authentication uses RapidAPI headers. Read more about this project on my blog!

APIs

The following is a synopsis; check out the full Swagger documentation.

Holidays

POST /api/v1/holidays
{
  "name": "Independence Day",
  "month": 7,
  "day": 4
}

Recipients

POST /api/v1/recipients
{
  "name": "Alice"
}

GiftIdeas

POST /api/v1/giftIdeas
{
  "holidayId": 123,
  "recipientId": 456,
  "giftDescription": "books"
}

The giftIdeas collection may be optionally queried by holiday or recipient:

GET /api/v1/giftIdeas?holidayId=123&recipientId=456

200 OK
{
  "items": [
    {
      "holidayId": 123,
      "recipientId": 456,
      "giftDescription": "books"
    }  
  ]
}

About

API for making note of gift ideas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages