Add: API documentation to README.md

Author: Alexander Dadyka

README.md

@@ -21,6 +21,7 @@
 - Nginx
 - PHP 8.2
 - PHPUnit
+- PostgreSQL 16
 - Presenters
 - Repository Pattern (with criteria queries)
 - RESTful API
@@ -72,3 +73,73 @@ docker-compose exec php-fpm php artisan test --coverage
 ```
 docker-compose exec php-fpm ./vendor/bin/phpunit --coverage-html ./storage/reports/coverage
 ```
+
+## API Endpoints
+
+### All Orders with pagination
+- Request URL: `http://localhost:8081/api/orders?start=0&end=2&sort_column=id&sort_type=asc`
+- Method: `GET`
+- Path: `/orders`
+- Request Parameters: `start, end, sort_column, sort_type`
+- Status Code: `200`
+- Response:
+```json
+{
+    "data": [
+        {
+            "id": 10000001,
+            "agency_name": "МКК ТверьВектор",
+            "status": "prepayment",
+            "is_confirmed": true,
+            "is_checked": true,
+            "rental_date": "21-12-2023",
+            "user_name": "Марат Романович Яковлев",
+            "transport_count": 3,
+            "guest_count": 3,
+            "admin_note": "Ну, душа, вот это так!"
+        },
+        {
+            "id": 10000002,
+            "agency_name": "ЗАО КазТехРечЛизинг",
+            "status": "waiting",
+            "is_confirmed": true,
+            "is_checked": true,
+            "rental_date": "27-12-2023",
+            "user_name": "Сергеева Эльвира Андреевна",
+            "transport_count": 3,
+            "guest_count": 3,
+            "admin_note": null
+        }
+    ]
+}
+```
+
+### Create Order
+- Request URL: `http://localhost:8081/api/orders`
+- Method: `POST`
+- Path: `/orders`
+- Request Parameters: `agency_name, rental_date, guest_count, transport_count, user_name, email, phone`
+- Status Code: `201`
+- Response:
+```json
+{
+    "data": {
+        "id": 10000011,
+        "agency_name": "Test Agency Name",
+        "status": "waiting",
+        "is_confirmed": false,
+        "is_checked": false,
+        "rental_date": "22-12-2023",
+        "user_name": "Test User Name",
+        "transport_count": 1,
+        "guest_count": 1,
+        "admin_note": null,
+        "note": null,
+        "email": "[email protected]",
+        "phone": "71437854547",
+        "confirmed_at": null,
+        "created_at": "21-12-2023 12:22:33",
+        "updated_at": "21-12-2023 12:22:33"
+    }
+}
+```