GET Get all restaurants #

This API endpoint is public and exposes a list of all the restaurants in The Fork:

It does not require a Bearer token.

{
  "data": [
    {
    "id": 1,
    "name": "Red Pizza",
    "address": "Apt. 120 8318 Ledner Pines, New Brockfurt, ND 37989-9210",
    "category": "italian",
    "user_id": 1,
    "created_at": "2023-01-12T14:50:43.902Z",
    "updated_at": "2023-01-12T14:50:43.902Z"
    },
    {
    "id": 2,
    "name": "Fast Sushi",
    "address": "5682 O'Keefe Crossroad, Kochfurt, RI 87403-4649",
    "category": "japanese",
    "user_id": 2,
    "created_at": "2023-01-12T14:50:43.912Z",
    "updated_at": "2023-01-12T14:50:43.912Z"
    },
    // [...] and more items
  ]
}
      

GET Search restaurants by category or location #

The public endpoint that exposes the list of all restaurants can also be used to search restaurants, simply by adding a query string with the location or category. It does not require a Bearer token.

{
  "data": [
    {
    "id": 2,
    "name": "Pasta e Basta",
    "address": "5682 O'Keefe Crossroad, Kochfurt, RI 87403-4649",
    "category": "italian",
    "user_id": 2,
    "created_at": "2023-01-12T14:50:43.912Z",
    "updated_at": "2023-01-12T14:50:43.912Z"
    }
  ]
}
      

{
  "data": [ ]
}
      

GET Get infos for a restaurant #

This API endpoint exposes the information for a specific restaurant in The Fork:

This endpoint is private and requires a bearer token, which you will find on your profile page once you are signed in.

{
  "data": [
    {
      "id": 10,
      "name": "Golden Cafe",
      "address": "Suite 550 4701 Balistreri Roads, South Charoletteberg, MN 81307",
      "category": "indian",
      "user_id": 3,
      "created_at": "2023-01-12T14:50:43.954Z",
      "updated_at": "2023-01-12T14:50:43.954Z"
    }
  ]
}
      

{
  "error": "You need to sign in or sign up before continuing."
}
      

POST Add a restaurant #

This API endpoint enables you to add a restaurant to The Fork:

This endpoint is private and requires a bearer token, which you will find on your profile page once you are signed in.

Please note that some conditions need to be met in order to create a new restaurant. In particular, category must be included in this list:

{
  "data": [
    {
      "id":5,
      "name":"New restaurant",
      "address":"London",
      "category":"korean",
      "user_id":4,
      "created_at":"2023-01-12T18:29:39.201Z",
      "updated_at":"2023-01-12T18:29:39.201Z"
    }
  ]
}
      

{
  "errors": ["Address can't be blank"]
}
      

{
  "error": "You need to sign in or sign up before continuing."
}
      

DELETE Delete a restaurant #

This API endpoint enables you to destroy a restaurant from The Fork:

This endpoint is private and requires a bearer token, which you will find on your profile page once you are signed in.

{
  "message": "Restaurant deleted"
}
      

{
  "error": "You need to sign in or sign up before continuing."
}
      

GET Get the chef for one restaurant #

This API endpoint exposes the chef for a specific restaurant in The Fork:

This endpoint is private and requires a bearer token, which you will find on your profile page once you are signed in.

For this endpoint you can choose what type of request you want back.

Simply by appending the url with .xml it will return a XML response. Appending the url with .json will return a JSON.

Back in the day XML was widely used as the main type of response for API's, until JSON took over.

• XML

• JSON

  <?xml version="1.0" encoding="UTF-8"?>
  <hash>
    <id type="integer">12</id>
    <name>Douglas</name>
    <years-of-experience type="integer">18</years-of-experience>
    <avatar-url>https://unsplash.com/photos/KTrov7eujms</avatar-url>
    <restaurant-id type="integer">14</restaurant-id>
    <created-at type="dateTime">2023-01-26T14:38:58Z</created-at>
    <updated-at type="dateTime">2023-01-26T14:38:58Z</updated-at>
  </hash>

      

  <?xml version="1.0" encoding="UTF-8"?>
  <errors>
    <error>You need to sign in or sign up before continuing.</error>
  </errors>

      

{
  "id": 28,
  "name": "Chef Romaguera",
  "years_of_experience": 14,
  "avatar_url": "https://unsplash.com/photos/kImU-9S9uh8",
  "restaurant_id": 30,
  "created_at": "2023-01-31T09:53:54.423Z",
  "updated_at": "2023-01-31T09:53:54.423Z"
}
      

{
  "error": "Couldn't find Restaurant with 'id'=10"
}
      

{
  "error": "You need to sign in or sign up before continuing."
}