Add API DOC to README

antonkanevsky · Sep 27, 2019 · 7b11056 · 7b11056
1 parent 2fcc2ec
commit 7b11056
Showing 1 changed file with 7 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -35,18 +35,10 @@ composer install
 php -S localhost:8000 -t public/
 ~~~
 
-Описание API методов
-------------
-API содержит 4 эндпоинта:
-1. Генерация стартового набора данных - создает сущности типа "Товар"
-**POST /api/items/create**
-2. Метод получения всех существующих товаров
-**GET /api/items**
-3. Создать заказ:
-**POST /api/order/create**
-Создает заказ в статусе "Новый".
-4. Оплатить заказ
-**POST /api/order/pay**
-
-*Примечание:*
-Для удобства тестирования в проекте есть файл для http клиента PostMan
+### API DOC к методам
+| № | HTTP метод | PATH              | Описание                                         | Параметры                                            | Пример запроса                      | Пример ответа         |
+|---|------------|-------------------|--------------------------------------------------|------------------------------------------------------|-------------------------------------|-----------------------|
+| 1 | POST       | /api/items/create | Создание товаров                                 |                                                      |                                     |                       |
+| 2 | GET        | /api/items        | Получение всех товаров                           |                                                      |                                     |                       |
+| 3 | POST       | /api/order/create | Создание заказа. Возвращает id созданного заказа | "itemIds" - Идентификаторы товаров                   | {   "itemIds": [1, 2] }             | {   "id": 1 }         |
+| 4 | POST       | /api/order/pay    | Оплата заказа                                    | "id" - Идентификатор заказа, "amount" - Сумма оплаты | {   "id": 1,   "amount": "250.00" } | {   "success": true } |