diff --git a/docs/API.ru.html b/docs/API.ru.html index 0a80036..9218c68 100644 --- a/docs/API.ru.html +++ b/docs/API.ru.html @@ -849,7 +849,7 @@ GET /orders/statistics

Хорошо:

// Возвращает агрегированную статистику заказов за указанный период
 POST /v1/orders/statistics/aggregate
-{ "start_date", "end_date" }
+{ "begin_date", "end_date" }
 

Стремитесь к тому, чтобы из сигнатуры функции было абсолютно ясно, что она делает, что принимает на вход и что возвращает. Вообще, при прочтении кода, работающего с вашим API, должно быть сразу понятно, что, собственно, он делает — без подглядывания в документацию.

Два важных следствия:

diff --git a/docs/API.ru.pdf b/docs/API.ru.pdf index 0f07eb4..29fd383 100644 Binary files a/docs/API.ru.pdf and b/docs/API.ru.pdf differ diff --git a/src/ru/clean-copy/02-I. Проектирование API/05.md b/src/ru/clean-copy/02-I. Проектирование API/05.md index 4a38fab..ab339f5 100644 --- a/src/ru/clean-copy/02-I. Проектирование API/05.md +++ b/src/ru/clean-copy/02-I. Проектирование API/05.md @@ -42,7 +42,7 @@ GET /orders/statistics ``` // Возвращает агрегированную статистику заказов за указанный период POST /v1/orders/statistics/aggregate -{ "start_date", "end_date" } +{ "begin_date", "end_date" } ``` **Стремитесь к тому, чтобы из сигнатуры функции было абсолютно ясно, что она делает, что принимает на вход и что возвращает**. Вообще, при прочтении кода, работающего с вашим API, должно быть сразу понятно, что, собственно, он делает — без подглядывания в документацию.