mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-01-05 10:20:22 +02:00
116 lines
9.5 KiB
HTML
116 lines
9.5 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>
|
|
Sergey Konstantinov. The API
|
|
</title>
|
|
<meta
|
|
name="description"
|
|
content="Designing APIs is a very special skill: API is a multiplier to both your opportunities and mistakes. This book is written to share the expertise and describe the best practices in designing and developing APIs. In Section I, we'll discuss the API architecture as a concept: how to build the hierarchy properly, from high-level planning down to final interfaces. Section II is dedicated to expanding existing APIs in a backwards-compatible manner. Finally, in Section III we will talk about the API as a product."
|
|
/>
|
|
<meta property="og:type" content="article" />
|
|
<meta
|
|
property="og:title"
|
|
content="Sergey Konstantinov. The API"
|
|
/>
|
|
<meta
|
|
property="og:description"
|
|
content="Designing APIs is a very special skill: API is a multiplier to both your opportunities and mistakes. This book is written to share the expertise and describe the best practices in designing and developing APIs. In Section I, we'll discuss the API architecture as a concept: how to build the hierarchy properly, from high-level planning down to final interfaces. Section II is dedicated to expanding existing APIs in a backwards-compatible manner. Finally, in Section III we will talk about the API as a product."
|
|
/>
|
|
<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="Sergey Konstantinov. The API"
|
|
/><br />
|
|
<h1>Sergey Konstantinov<br/><span class="title">The API</span></h1>
|
|
<h2>Free e-book</h2>
|
|
<br />Subscribe for updates on <a class="github" href="https://github.com/twirl/The-API-Book"></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="medium" href="https://twirl.medium.com/">Medium</a>
|
|
<br />Support this work on <a class="patreon" href="https://www.patreon.com/yatwirl">Patreon</a> · <a class="kindle" href="https://www.amazon.com/gp/product/B09RHH44S5/ref=dbs_a_def_rwt_hsch_vapi_tkin_p1_i0">buy Kindle version</a>
|
|
<br />Share: <a class="share share-facebook" href="https://www.facebook.com/sharer.php?u=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2F" target="_blank"></a> · <a class="share share-twitter" href="https://twitter.com/intent/tweet?text=The%20API%20by%20Sergey%20Konstantinov%20%E2%80%94%20a%20book%20about%20designing%20APIs%2C%20extending%20them%20and%20finding%20a%20proper%20place%20in%20the%20market&url=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2F&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%2F" target="_blank"></a> · <a class="share share-reddit" href="http://www.reddit.com/submit?url=https%3A%2F%2Ftwirl.github.io%2FThe-API-Book%2F&title=The%20API%20by%20Sergey%20Konstantinov%20%E2%80%94%20a%20book%20about%20designing%20APIs%2C%20extending%20them%20and%20finding%20a%20proper%20place%20in%20the%20market" target="_blank"></a><br/>⚙️⚙️⚙️
|
|
</nav>
|
|
<p>The API-first development is one of the hottest technical topics nowadays, since many companies started to realize that API serves as a multiplicator to their opportunities—but it also amplifies the design mistakes as well.</p>
|
|
<p>This book is written to share the expertise and describe the best practices in designing and developing APIs. In Section I, we'll discuss the API architecture as a concept: how to build the hierarchy properly, from high-level planning down to final interfaces. Section II is dedicated to expanding existing APIs in a backwards-compatible manner. Finally, in Section III we will talk about the API as a product.</p>
|
|
<p>Illustration & inspiration: <a href="https://www.instagram.com/art.mari.ka/">art.mari.ka</a>.</p>
|
|
<p>You might download ‘The API’ in <a href="API.en.pdf">PDF</a>, <a href="API.en.epub">EPUB</a>, or <a href="API.en.html">read it online</a>.
|
|
</p>
|
|
<h3>Table of Contents</h3>
|
|
<ul><li>
|
|
<h4><a href="API.en.html#section-1">Introduction</a></h4>
|
|
<ul>
|
|
<li><a href="API.en.html#chapter-1">Chapter 1. On the Structure of This Book</a></li>
|
|
<li><a href="API.en.html#chapter-2">Chapter 2. The API Definition</a></li>
|
|
<li><a href="API.en.html#chapter-3">Chapter 3. API Quality Criteria</a></li>
|
|
<li><a href="API.en.html#chapter-4">Chapter 4. Backwards Compatibility</a></li>
|
|
<li><a href="API.en.html#chapter-5">Chapter 5. On Versioning</a></li>
|
|
<li><a href="API.en.html#chapter-6">Chapter 6. Terms and Notation Keys</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.en.html#section-2">Section I. The API Design</a></h4>
|
|
<ul>
|
|
<li><a href="API.en.html#chapter-7">Chapter 7. The API Contexts Pyramid</a></li>
|
|
<li><a href="API.en.html#chapter-8">Chapter 8. Defining an Application Field</a></li>
|
|
<li><a href="API.en.html#chapter-9">Chapter 9. Separating Abstraction Levels</a></li>
|
|
<li><a href="API.en.html#chapter-10">Chapter 10. Isolating Responsibility Areas</a></li>
|
|
<li><a href="API.en.html#chapter-11">Chapter 11. Describing Final Interfaces</a></li>
|
|
<li><a href="API.en.html#chapter-12">Chapter 12. Annex to Section I. Generic API Example</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.en.html#section-3">Section II. The Backwards Compatibility</a></h4>
|
|
<ul>
|
|
<li><a href="API.en.html#chapter-13">Chapter 13. The Backwards Compatibility Problem Statement</a></li>
|
|
<li><a href="API.en.html#chapter-14">Chapter 14. On the Waterline of the Iceberg</a></li>
|
|
<li><a href="API.en.html#chapter-15">Chapter 15. Extending through Abstracting</a></li>
|
|
<li><a href="API.en.html#chapter-16">Chapter 16. Strong Coupling and Related Problems</a></li>
|
|
<li><a href="API.en.html#chapter-17">Chapter 17. Weak Coupling</a></li>
|
|
<li><a href="API.en.html#chapter-18">Chapter 18. Interfaces as a Universal Pattern</a></li>
|
|
<li><a href="API.en.html#chapter-19">Chapter 19. The Serenity Notepad</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h4><a href="API.en.html#section-4">Section III. The API Product</a></h4>
|
|
<ul>
|
|
<li><a href="API.en.html#chapter-20">Chapter 20. API as a Product</a></li>
|
|
<li><a href="API.en.html#chapter-21">Chapter 21. The API Business Models</a></li>
|
|
<li><a href="API.en.html#chapter-22">Chapter 22. Developing a Product Vision</a></li>
|
|
<li><a href="API.en.html#chapter-23">Chapter 23. Communicating with Developers</a></li>
|
|
<li><a href="API.en.html#chapter-24">Chapter 24. Communicating with Business Owners</a></li>
|
|
<li><a href="API.en.html#chapter-25">Chapter 25. The API Services Range</a></li>
|
|
<li><a href="API.en.html#chapter-26">Chapter 26. The API Key Performance Indicators</a></li>
|
|
<li><a href="API.en.html#chapter-27">Chapter 27. Identifying Users and Preventing Fraud</a></li>
|
|
<li><a href="API.en.html#chapter-28">Chapter 28. The Technical Means of Preventing ToS Violations</a></li>
|
|
<li><a href="API.en.html#chapter-29">Chapter 29. Supporting customers</a></li>
|
|
<li><a href="API.en.html#chapter-30">Chapter 30. The Documentation</a></li>
|
|
<li><a href="API.en.html#chapter-31">Chapter 31. The Testing Environment</a></li>
|
|
<li><a href="API.en.html#chapter-32">Chapter 32. Managing expectations</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>This book is distributed under the <a href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International licence</a>.</p>
|
|
<p>Source code available at <a href="https://github.com/twirl/The-API-Book">github.com/twirl/The-API-Book</a></p>
|
|
<h3><a name="about-author">About the Author</a></h3>
|
|
<section class="about-me">
|
|
<aside><img src="https://konstantinov.cc/static/me.png"/><br/>Photo by <a href="http://linkedin.com/in/zloylos/">Denis Hananein</a></aside>
|
|
<div class="content">
|
|
<p>Sergey Konstantinov has been working with APIs for more than a decade. He started his career as a software engineer in the Maps API division at Yandex and eventually became the head of the service, being responsible for both technical architecture and product management.</p>
|
|
<p>During this tenure, Sergey got a unique experience in building world-class APIs with a daily audience of tens of millions, planning roadmaps for such a service, and giving numerous public speeches. He also worked for a year and a half as a member of the W3C Technical Architecture Group.</p>
|
|
<p>After nine years in Maps, Sergey switched to technical-lead roles in other departments and companies, leading integration efforts and being responsible for the technical architecture of entire business units. Today, Sergey lives in Tallinn, Estonia, and works as a staff software engineer at Bolt.</p></div>
|
|
</section>
|
|
<p>Книгу «API» можно <a href="index.ru.html">читать по-русски</a>.</p>
|
|
</body>
|
|
</html> |