From e638172a36c8ab583921f4ffe85dcbdf2215b1b8 Mon Sep 17 00:00:00 2001 From: Sergey Konstantinov Date: Mon, 7 Dec 2020 21:54:50 +0300 Subject: [PATCH] stylistic fixes --- docs/API.ru.html | 40 +++++++++--------- docs/API.ru.pdf | Bin 3902029 -> 3897616 bytes src/ru/clean-copy/01-Введение/05.md | 8 ++-- src/ru/clean-copy/01-Введение/06.md | 4 +- .../clean-copy/02-I. Проектирование API/02.md | 10 ++--- .../clean-copy/02-I. Проектирование API/05.md | 18 ++++---- 6 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/API.ru.html b/docs/API.ru.html index 9218c68..6d4a0ab 100644 --- a/docs/API.ru.html +++ b/docs/API.ru.html @@ -137,10 +137,10 @@ h4, h5 {

Более подробно о жизненном цикле API и политиках выпуска новых версий будет рассказано в разделе II.

Глава 5. О версионировании

Здесь и далее мы будем придерживаться принципов версионирования semver:

    -
  1. Версия API задаётся тремя цифрами, вида 1.2.3
    2. -
  2. Первая цифра (мажорная версия) увеличивается при обратно несовместимых изменениях в API
    3. -
  3. Вторая цифра (минорная версия) увеличивается при добавлении новой функциональности с сохранением обратной совместимости
    4. -
  4. Третья цифра (патч) увеличивается при выпуске новых версий, содержащих только исправление ошибок
    5. +
  5. Версия API задаётся тремя цифрами, вида 1.2.3.
    6. +
  6. Первая цифра (мажорная версия) увеличивается при обратно несовместимых изменениях в API.
    7. +
  7. Вторая цифра (минорная версия) увеличивается при добавлении новой функциональности с сохранением обратной совместимости.
    8. +
  8. Третья цифра (патч) увеличивается при выпуске новых версий, содержащих только исправление ошибок.

Выражения «мажорная версия API» и «версия API, содержащая обратно несовместимые изменения функциональности» тем самым следует считать эквивалентными.

Более подробно о политиках версионирования будет рассказано в разделе II. В разделе I мы ограничимся лишь указанием версии API в формате v1, v2, etc.

Глава 6. Условные обозначения и терминология

@@ -168,10 +168,10 @@ Cache-Control: no-cache

Её следует читать так:

@@ -196,7 +196,7 @@ Cache-Control: no-cache

  • Какую проблему мы решаем? Действительно ли решение этой проблемы находится в нашей компетенции? Действительно ли мы находимся в той позиции, чтобы решить эту проблему?

  • Какую проблему мы решаем? Правда ли, что решение, которое мы предлагаем, действительно решает проблему? Не создаём ли мы на её месте другую проблему, более сложную?

    • -

    Итак, предположим, что мы хотим предоставить API автоматического заказа кофе в городских кофейнях. Попробуем применить к ней этот принцип.

    +

    Итак, предположим, что мы хотим предоставить API автоматического заказа кофе в городских кофейнях. Попробуем применить к нему этот принцип.

    1. Зачем кому-то может потребоваться API для приготовления кофе? В чем неудобство заказа кофе через интерфейс, человек-человек или человек-машина? Зачем нужна возможность заказа машина-машина?