books/The-API-Book
1
0
Fork 0
mirror of https://github.com/twirl/The-API-Book.git synced 2025-04-23 11:07:53 +02:00
Code Issues Releases Activity

typo

Browse Source
This commit is contained in:
Sergey Konstantinov 2020-12-07 12:32:21 +03:00
parent 5ead108c5d
commit ad738b7466
3 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.ru.html
View File

@ -849,7 +849,7 @@ GET /orders/statistics
<p><strong>Хорошо</strong>:</p>
<pre><code>// Возвращает агрегированную статистику заказов за указанный период
POST /v1/orders/statistics/aggregate
{ "start_date", "end_date" }
{ "begin_date", "end_date" }
</code></pre>
<p><strong>Стремитесь к тому, чтобы из сигнатуры функции было абсолютно ясно, что она делает, что принимает на вход и что возвращает</strong>. Вообще, при прочтении кода, работающего с вашим API, должно быть сразу понятно, что, собственно, он делает — без подглядывания в документацию.</p>
<p>Два важных следствия:</p>

BIN
docs/API.ru.pdf
View File

Binary file not shown.

2
src/ru/clean-copy/02-I. Проектирование API/05.md
View File

@ -42,7 +42,7 @@ GET /orders/statistics
```
// Возвращает агрегированную статистику заказов за указанный период
POST /v1/orders/statistics/aggregate
{ "start_date", "end_date" }
{ "begin_date", "end_date" }
```
**Стремитесь к тому, чтобы из сигнатуры функции было абсолютно ясно, что она делает, что принимает на вход и что возвращает**. Вообще, при прочтении кода, работающего с вашим API, должно быть сразу понятно, что, собственно, он делает — без подглядывания в документацию.