Приклад опису REST API

Get all menu items

Request (запит на сервер)

  • Method : GET (метод відправки даних)

  • URL : http://lab.kids-lu-server.xyz/api/v1/menu (адреса відправки даних)

  • Headers : (якщо сервер вимагає авторизації, то необхідно відправляти Authorization header)

    KeyValue
    Authorization Basic dGVzdDp0ZXN0
  • Description : Get all menu items (в результаті отримаємо список всіх елементів меню) 

Response example (приклад об'єкту, який повертає сервер у відповідь на запит)

{
    "total": 1,
    "list": [
        {
            "id": "5992c23cdd217b18c",
            "name": "Спаржа з сиром «Тофу» та грибами шиітаке",
            "deleted": false,
            "description": "Хрустка спаржа, обсмажена з грибами Шиітаке та соєвим сиром «Тофу» під імбирно-кунжутною заправкою",
            "createdAt": "2017-08-15 09:43:24",
            "modifiedAt": "2017-08-15 09:43:24",
            "price": 95,
            "weight": 190,
            "category": "Закуски",
            "special": false,
            "new": true,
            "extra": "Японська кухня",
            "createdById": "1",
            "createdByName": "Admin",
            "modifiedById": null,
            "modifiedByName": null,
            "assignedUserId": "1",
            "assignedUserName": "Admin"
        }
    ]
}
Остання зміна: четвер 17 серпень 2017 2:39