Название: API
Автор: Сергей Константинов
Издательство: Интернет-издание
Год: 2020
Страниц: 86
Язык: русский
Формат: pdf
Размер: 10,1 MB

«API-first» подход — одна из самых горячих горячих тем в разработке программного обеспечения в 2020. Многие компании начали понимать, что API выступает мультипликатором их возможностей — но также умножает и допущенные ошибки. Эта книга посвящена проектированию API: как правильно выстроить архитектуру, начиная с высокоуровневого планирования из заканчивая деталями реализации конкретных интерфейсов.

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

Первые два будут интересны скорее разработчикам, третий — и разработчикам, и менеджерам. При этом мы настаиваем, что как раз третий раздел — самый важный для разработчика API. Ввиду того, что API — продукт для разработчиков, перекладывать ответственность за его развитие и поддержку на не-разработчиков неправильно: никто кроме вас самих не понимает так хорошо продуктовые свойства вашего API.

Большинство примеров API в общих разделах будут даны в виде JSON-over-HTTP-эндпойтов. Это некоторая условность, которая помогает описать концепции, как нам кажется, максимально понятно. Вместо GET /v1/orders вполне может быть вызов метода orders.get(), локальный или удалённый; вместо JSON может быть любой другой формат данных. Смысл утверждений от этого не меняется.

Помимо HTTP API-нотации мы будем активно использовать C-подобный псевдокод — точнее будет сказать, jаvascript или Python-подобный, поскольку нотации типов мы будем опускать. Мы предполагаем, что подобного рода императивные конструкции достаточно читабельны, и не будем здесь описывать грамматику подробно.