mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-04-11 11:02:05 +02:00
168 lines
18 KiB
HTML
168 lines
18 KiB
HTML
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<link rel="icon" type="image/png" href="assets/favicon.png" />
|
|
<title>
|
|
Сергей Константинов. API
|
|
</title>
|
|
<meta
|
|
name="description"
|
|
content="Разработка API — особый навык: API является как мультипликатором ваших возможностей, так и мультипликатором ваших ошибок. Эта книга написана для того, чтобы поделиться опытом и изложить лучшие практики разработки API. Книга состоит из шести разделов, посвящённых проектированию API, паттернам дизайна API, поддержанию обратной совместимости, HTTP API и архитектурным принципам REST, SDK и UI-библиотекам, продуктовому управлению API."
|
|
/>
|
|
<meta property="og:type" content="article" />
|
|
<meta
|
|
property="og:title"
|
|
content="Сергей Константинов. API"
|
|
/>
|
|
<meta
|
|
property="og:description"
|
|
content="Разработка API — особый навык: API является как мультипликатором ваших возможностей, так и мультипликатором ваших ошибок. Эта книга написана для того, чтобы поделиться опытом и изложить лучшие практики разработки API. Книга состоит из шести разделов, посвящённых проектированию API, паттернам дизайна API, поддержанию обратной совместимости, HTTP API и архитектурным принципам REST, SDK и UI-библиотекам, продуктовому управлению API."
|
|
/>
|
|
<meta property="og:image" content="assets/header.png" />
|
|
<meta
|
|
property="og:url"
|
|
content="https://github.com/twirl/The-API-Book"
|
|
/>
|
|
<link rel="stylesheet" href="assets/landing.css"/>
|
|
</head>
|
|
<body>
|
|
<nav>
|
|
<img
|
|
class="header"
|
|
src="assets/header.jpg"
|
|
alt="Сергей Константинов. API"
|
|
/><br />
|
|
<h1>Сергей Константинов<br/><span class="title">API</span></h1>
|
|
<h2>Бесплатная электронная книга</h2>
|
|
<br />Подпишитесь на обновления на <a class="habr" href="https://habr.com/ru/users/forgotten/">Хабре</a>
|
|
<br/>Follow me on <a class="linkedin" href="https://www.linkedin.com/in/twirl/"></a> · <a class="twitter" href="https://twitter.com/blogovodoved"></a> · <a class="substack" href="https://twirl.substack.com/">Substack</a>
|
|
<br />Поддержите эту работу на <a class="patreon" href="https://www.patreon.com/yatwirl">Patreon</a>
|
|
<br />Поделиться: <a class="share share-facebook" href="https://www.facebook.com/sharer.php?u=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2Findex.ru.html" target="_blank"></a> · <a class="share share-twitter" href="https://twitter.com/intent/tweet?text=%C2%ABAPI%C2%BB%20%D0%A1%D0%B5%D1%80%D0%B3%D0%B5%D1%8F%20%D0%9A%D0%BE%D0%BD%D1%81%D1%82%D0%B0%D0%BD%D1%82%D0%B8%D0%BD%D0%BE%D0%B2%D0%B0%20%E2%80%94%20%D0%BA%D0%BD%D0%B8%D0%B3%D0%B0%20%D0%BE%20%D0%B4%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%20API%20%D0%B8%20%D0%B5%D0%B3%D0%BE%20%D0%BF%D1%80%D0%BE%D0%B4%D1%83%D0%BA%D1%82%D0%BE%D0%B2%D0%BE%D0%BC%20%D0%B8%20%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%BC%20%D1%80%D0%B0%D0%B7%D0%B2%D0%B8%D1%82%D0%B8%D0%B8&url=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2Findex.ru.html&hashtags=API%2CTheAPIBook&via=blogovodoved" target="_blank"></a> · <a class="share share-linkedin" href="https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2Findex.ru.html" target="_blank"></a> · <a class="share share-reddit" href="http://www.reddit.com/submit?url=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2Findex.ru.html&title=%C2%ABAPI%C2%BB%20%D0%A1%D0%B5%D1%80%D0%B3%D0%B5%D1%8F%20%D0%9A%D0%BE%D0%BD%D1%81%D1%82%D0%B0%D0%BD%D1%82%D0%B8%D0%BD%D0%BE%D0%B2%D0%B0%20%E2%80%94%20%D0%BA%D0%BD%D0%B8%D0%B3%D0%B0%20%D0%BE%20%D0%B4%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%20API%20%D0%B8%20%D0%B5%D0%B3%D0%BE%20%D0%BF%D1%80%D0%BE%D0%B4%D1%83%D0%BA%D1%82%D0%BE%D0%B2%D0%BE%D0%BC%20%D0%B8%20%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%BC%20%D1%80%D0%B0%D0%B7%D0%B2%D0%B8%D1%82%D0%B8%D0%B8" target="_blank"></a><br/>⚙️⚙️⚙️
|
|
</nav>
|
|
<p>«API-first» подход — одна из самых горячих горячих тем в разработке программного обеспечения в наше время. Многие компании начали понимать, что API выступает мультипликатором их возможностей — но также умножает и допущенные ошибки.</p>
|
|
<p>Эта книга написана для того, чтобы поделиться опытом и изложить лучшие практики разработки API. Книга состоит из шести разделов, посвящённых:</p>
|
|
<ul><li>— проектированию API,</li>
|
|
<li>— паттернам дизайна API,</li>
|
|
<li>— поддержанию обратной совместимости,</li>
|
|
<li>— HTTP API и архитектурным принципам REST,</li>
|
|
<li>— SDK и UI-библиотекам,</li>
|
|
<li>— продуктовому управлению API.</li></ul>
|
|
<p>Иллюстрации и вдохновение: Maria Konstantinova · <a href="https://www.instagram.com/art.mari.ka/">art.mari.ka</a>.</p>
|
|
<p>Вы можете скачать книгу «API» в формате <a href="API.ru.pdf">PDF</a> / <a href="API.ru.epub">EPUB</a> или <a href="API.ru.html">прочитать её онлайн</a>.
|
|
</p>
|
|
<h3>Содержание</h3>
|
|
<ul><li>
|
|
<h4><a href="API.ru.html#section-1">Введение</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#intro-structure">Глава 1. О структуре этой книги</a></li>
|
|
<li><a href="API.ru.html#intro-api-definition">Глава 2. Определение API</a></li>
|
|
<li><a href="API.ru.html#intro-api-solutions-overview">Глава 3. Обзор существующих решений в области разработки API</a></li>
|
|
<li><a href="API.ru.html#intro-api-quality">Глава 4. Критерии качества API</a></li>
|
|
<li><a href="API.ru.html#intro-api-first-approach">Глава 5. API-first подход</a></li>
|
|
<li><a href="API.ru.html#intro-back-compat">Глава 6. Обратная совместимость</a></li>
|
|
<li><a href="API.ru.html#intro-versioning">Глава 7. О версионировании</a></li>
|
|
<li><a href="API.ru.html#intro-terms-notation">Глава 8. Условные обозначения и терминология</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-2">Раздел I. Проектирование API</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#api-design-context-pyramid">Глава 9. Пирамида контекстов API</a></li>
|
|
<li><a href="API.ru.html#api-design-defining-field">Глава 10. Определение области применения</a></li>
|
|
<li><a href="API.ru.html#api-design-separating-abstractions">Глава 11. Разделение уровней абстракции</a></li>
|
|
<li><a href="API.ru.html#api-design-isolating-responsibility">Глава 12. Разграничение областей ответственности</a></li>
|
|
<li><a href="API.ru.html#api-design-describing-interfaces">Глава 13. Описание конечных интерфейсов</a></li>
|
|
<li><a href="API.ru.html#api-design-annex">Глава 14. Приложение к разделу I. Модельный API</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-3">Раздел II. Паттерны дизайна API</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#chapter-15">Глава 15. О паттернах проектирования в контексте API</a></li>
|
|
<li><a href="API.ru.html#api-patterns-aa">Глава 16. Аутентификация партнёров и авторизация вызовов API</a></li>
|
|
<li><a href="API.ru.html#api-patterns-sync-strategies">Глава 17. Стратегии синхронизации</a></li>
|
|
<li><a href="API.ru.html#api-patterns-weak-consistency">Глава 18. Слабая консистентность</a></li>
|
|
<li><a href="API.ru.html#api-patterns-async">Глава 19. Асинхронность и управление временем</a></li>
|
|
<li><a href="API.ru.html#api-patterns-lists">Глава 20. Списки и организация доступа к ним</a></li>
|
|
<li><a href="API.ru.html#api-patterns-push-vs-poll">Глава 21. Двунаправленные потоки данных. Push и poll-модели</a></li>
|
|
<li><a href="API.ru.html#api-patterns-async-event-processing">Глава 22. Мультиплексирование сообщений. Асинхронная обработка событий</a></li>
|
|
<li><a href="API.ru.html#api-patterns-atomicity">Глава 23. Атомарность массовых изменений</a></li>
|
|
<li><a href="API.ru.html#api-patterns-partial-updates">Глава 24. Частичные обновления</a></li>
|
|
<li><a href="API.ru.html#api-patterns-degrading">Глава 25. Деградация и предсказуемость</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-4">Раздел III. Обратная совместимость</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#back-compat-statement">Глава 26. Постановка проблемы обратной совместимости</a></li>
|
|
<li><a href="API.ru.html#back-compat-iceberg-waterline">Глава 27. О ватерлинии айсберга</a></li>
|
|
<li><a href="API.ru.html#back-compat-abstracting-extending">Глава 28. Расширение через абстрагирование</a></li>
|
|
<li><a href="API.ru.html#back-compat-strong-coupling">Глава 29. Сильная связность и сопутствующие проблемы</a></li>
|
|
<li><a href="API.ru.html#back-compat-weak-coupling">Глава 30. Слабая связность</a></li>
|
|
<li><a href="API.ru.html#back-compat-universal-interfaces">Глава 31. Интерфейсы как универсальный паттерн</a></li>
|
|
<li><a href="API.ru.html#back-compat-serenity-notepad">Глава 32. Блокнот душевного покоя</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-5">Раздел IV. HTTP API и архитектурные принципы REST</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#http-api-concepts">Глава 33. О концепции HTTP API и терминологии</a></li>
|
|
<li><a href="API.ru.html#http-api-pros-and-cons">Глава 34. Преимущества и недостатки HTTP API в сравнении с альтернативными технологиями</a></li>
|
|
<li><a href="API.ru.html#http-api-rest-myth">Глава 35. Мифология REST</a></li>
|
|
<li><a href="API.ru.html#http-api-requests-semantics">Глава 36. Составляющие HTTP запросов и их семантика</a></li>
|
|
<li><a href="API.ru.html#http-api-rest-organizing">Глава 37. Организация HTTP API согласно принципам REST</a></li>
|
|
<li><a href="API.ru.html#http-api-urls-crud">Глава 38. Разработка номенклатуры URL ресурсов. CRUD-операции</a></li>
|
|
<li><a href="API.ru.html#http-api-errors">Глава 39. Работа с ошибками в HTTP API</a></li>
|
|
<li><a href="API.ru.html#http-api-final-recommendations">Глава 40. Заключительные положения и общие рекомендации</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-6">[В разработке] Раздел V. SDK и UI</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#sdk-toc">Глава 41. О содержании раздела</a></li>
|
|
<li><a href="API.ru.html#sdk-problems-solutions">Глава 42. SDK: проблемы и решения</a></li>
|
|
<li><a href="API.ru.html#chapter-43">Глава 43. Кодогенерация</a></li>
|
|
<li><a href="API.ru.html#chapter-44">Глава 44. UI-компоненты</a></li>
|
|
<li><a href="API.ru.html#chapter-45">Глава 45. Декомпозиция UI-компонентов. MV*-подходы</a></li>
|
|
<li><a href="API.ru.html#chapter-46">Глава 46. MV*-фреймворки</a></li>
|
|
<li><a href="API.ru.html#chapter-47">Глава 47. Backend-Driven UI</a></li>
|
|
<li><a href="API.ru.html#chapter-48">Глава 48. Разделяемые ресурсы и асинхронные блокировки</a></li>
|
|
<li><a href="API.ru.html#chapter-49">Глава 49. Вычисляемые свойства</a></li>
|
|
<li><a href="API.ru.html#chapter-50">Глава 50. В заключение</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.ru.html#section-7">Раздел VI. API как продукт</a></h4>
|
|
<ul>
|
|
<li><a href="API.ru.html#api-product">Глава 51. Продукт API</a></li>
|
|
<li><a href="API.ru.html#api-product-business-models">Глава 52. Бизнес-модели API</a></li>
|
|
<li><a href="API.ru.html#api-product-vision">Глава 53. Формирование продуктового видения</a></li>
|
|
<li><a href="API.ru.html#api-product-devrel">Глава 54. Взаимодействие с разработчиками</a></li>
|
|
<li><a href="API.ru.html#api-product-business-comms">Глава 55. Взаимодействие с бизнес-аудиторией</a></li>
|
|
<li><a href="API.ru.html#api-product-range">Глава 56. Линейка сервисов API</a></li>
|
|
<li><a href="API.ru.html#api-product-kpi">Глава 57. Ключевые показатели эффективности API</a></li>
|
|
<li><a href="API.ru.html#api-product-antifraud">Глава 58. Идентификация пользователей и борьба с фродом</a></li>
|
|
<li><a href="API.ru.html#api-product-tos-violations">Глава 59. Технические способы борьбы с несанкционированным доступом к API</a></li>
|
|
<li><a href="API.ru.html#api-product-customer-support">Глава 60. Поддержка пользователей API</a></li>
|
|
<li><a href="API.ru.html#api-product-documentation">Глава 61. Документация</a></li>
|
|
<li><a href="API.ru.html#api-product-testing">Глава 62. Тестовая среда</a></li>
|
|
<li><a href="API.ru.html#api-product-expectations">Глава 63. Управление ожиданиями</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>Это произведение доступно по <a href="http://creativecommons.org/licenses/by-nc/4.0/">лицензии Creative Commons «Attribution-NonCommercial» («Атрибуция — Некоммерческое использование») 4.0 Всемирная</a>.</p>
|
|
<p>Исходный код доступен на <a href="https://github.com/twirl/The-API-Book">github.com/twirl/The-API-Book</a></p>
|
|
<h3><a name="about-author">Об авторе</a></h3>
|
|
<section class="about-me">
|
|
<aside><img src="https://konstantinov.cc/static/me.png"/><br/>Фото: <a href="http://linkedin.com/in/zloylos/">Denis Hananein</a></aside>
|
|
<div class="content">
|
|
<p>Сергей Константинов работает с API уже больше десятилетия. Он начинал свою карьеру разработчиком в подразделении API Яндекс.Карт, и со временем стал руководителем всего сервиса, отвечая и за техническую, и за продуктовую составляющую.</p>
|
|
<p>За это время Сергей получил уникальный опыт построения API мирового уровня с дневной аудиторией в десятки миллионов человек, планирования роадмапов для такого продукта и многочисленных публичных выступлений. Он также проработал полтора года в составе Технической архитектурной группы W3C.</p>
|
|
<p>После девяти лет в Картах Сергей переключился на технические роли в других департаментах и компаниях, занимаясь интеграционными проектами и будучи ответственным за техническую архитектуру целых продуктов компании. Сегодня Сергей живёт в Таллинне, Эстония, и работает ведущим инженером в компании Bolt.</p></div>
|
|
</section>
|
|
<p>You might also <a href="index.html">read ‘The API’ in English</a>.</p>
|
|
</body>
|
|
</html> |