twirl / the-api-book Goto Github PK

• src/ru/clean-copy/02-Раздел I. Проектирование API/03.md: взамодействие, перепрыгывания.
• src/en/clean-copy/01-Introduction/06.md: sentenses.
• src/en/clean-copy/02-Section I. The API Design/03.md: abovementioned

Suggesting to use https://github.com/hcodes/yaspeller

Опечатка в

Вопрос этот с подвохом: в том виде, как мы описали партнёрскЫй API

Тут слово "нетразитивным" кажется должно быть "нетранзитивным"

Привет! Спасибо за труд :)

У меня возник вопрос на который я не нашел ответа в книжке. Почему для endpoint /search используется POST, а не GET? С одной стороны интересны причины и точка зрения, а с другой стороны, как мне кажется, в книгу было бы круто добавить это объяснение, так как POST это про создание данных на сервере, а GET про чтение (но с другой стороны есть идемпотентность и история поиска).

volume.format vs formatVolume в комментарии ниже.

• либо в запросе содержатся только идентификаторы, и имплементации методов сами обратятся за нужными данными через какие-то внутренние API.

есть предложение по этой строке, по аналогии с англоязычным вариантом

or the request contains only data identifiers, and next in chain handler will request pieces of data it needs via some internal APIs.

кажется, более корректным было бы так:

• либо в запросе содержатся только идентификаторы и следующие обработчики в цепочке сами обратятся за нужными данными через какие-то внутренние API.

В самом конце:

...каким своим срезом она выступает во взаимодействии с каким объектами.

The-API-Book/src/ru/clean-copy/03-Раздел II. Обратная совместимость/06.md

Line 13 in 27c244d

Например, разрабатывая API эндпойнта `POST /search` мы должны были задать себе вопрос: а «результат поиска» — это абстракция над каким интерфейсом? Для этого нам нужно аккуратно декомпозировать эту сущность, чтобы понять, каким своим срезом она выступает во взаимодействии с каким объектами.

https://github.com/twirl/The-API-Book/blob/69097c27d844ae6c5ec642cecc7095c3f96651cc/src/ru/clean-copy/02-%D0%A0%D0%B0%D0%B7%D0%B4%D0%B5%D0%BB%20I.%20%D0%9F%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20API/04.md

В псевдокоде, вероятно, должно быть app.display(matchingCoffeeMachines); вместо app.display(coffeeMachines);

Согласно определению: API — это программный интерфейс приложений. То есть у аббревиатуры API мужской род. Если это знать то, использование API в среднем роде "бьёт по ушам" также как и "хорошее кофе".

Hard to read generated PDF file.

Suggesting to add styles before generate PDF:

const printStyles = `
@media print {
    * { 
        text-align: left;
        line-height: 1.55;
    }
    code, pre {
        white-space: pre-wrap;
    }
    h1, h2, h3, h4, h5, h6 {
        page-break-inside: avoid;
    }
    h1::after, h2::after, h3::after, h4::after, h5::after, h6::after {
        content: "";
        display: block;
        height: 100px;
        margin-bottom: -100px;
    }
    p {
        orphans: 2;
        widows: 2;
    }
}`;

async function buildPdf() {
    //…
    await page.addStyleTag({ content: printStyles });
    //…
}

Thx for book, sir.

В главе 11, пункт 9, скорее всего, неправильный падеж в первом же предложении:

Правило можно ещё сформулировать так: не заставляйте клиент гадать.

Полагаю, слово «клиент» планировалось написать в родительном падеже: «клиента».