mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-04-17 11:06:25 +02:00
corrections
This commit is contained in:
parent
d62bb294a2
commit
6fe91710f3
BIN
docs/API.en.epub
BIN
docs/API.en.epub
Binary file not shown.
File diff suppressed because one or more lines are too long
BIN
docs/API.en.pdf
BIN
docs/API.en.pdf
Binary file not shown.
BIN
docs/API.ru.epub
BIN
docs/API.ru.epub
Binary file not shown.
BIN
docs/API.ru.pdf
BIN
docs/API.ru.pdf
Binary file not shown.
@ -10,7 +10,7 @@
|
|||||||
</title>
|
</title>
|
||||||
<meta
|
<meta
|
||||||
name="description"
|
name="description"
|
||||||
content="API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & REST architectural principles, SDKs and UI libraries, API product management."
|
content="API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & the REST architectural principles, SDKs and UI libraries, API product management."
|
||||||
/>
|
/>
|
||||||
<meta property="og:type" content="article" />
|
<meta property="og:type" content="article" />
|
||||||
<meta
|
<meta
|
||||||
@ -19,7 +19,7 @@
|
|||||||
/>
|
/>
|
||||||
<meta
|
<meta
|
||||||
property="og:description"
|
property="og:description"
|
||||||
content="API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & REST architectural principles, SDKs and UI libraries, API product management."
|
content="API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & the REST architectural principles, SDKs and UI libraries, API product management."
|
||||||
/>
|
/>
|
||||||
<meta property="og:image" content="assets/header.png" />
|
<meta property="og:image" content="assets/header.png" />
|
||||||
<meta
|
<meta
|
||||||
@ -47,7 +47,7 @@
|
|||||||
<ul><li>— The API design</li>
|
<ul><li>— The API design</li>
|
||||||
<li>— API patterns</li>
|
<li>— API patterns</li>
|
||||||
<li>— Backward compatibility</li>
|
<li>— Backward compatibility</li>
|
||||||
<li>— HTTP APIs & REST architectural principles</li>
|
<li>— HTTP APIs & the REST architectural principles</li>
|
||||||
<li>— SDKs and UI libraries</li>
|
<li>— SDKs and UI libraries</li>
|
||||||
<li>— API product management.</ul>
|
<li>— API product management.</ul>
|
||||||
<p>Illustration & inspiration: <a href="https://www.instagram.com/art.mari.ka/">art.mari.ka</a>.</p>
|
<p>Illustration & inspiration: <a href="https://www.instagram.com/art.mari.ka/">art.mari.ka</a>.</p>
|
||||||
@ -107,7 +107,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<h4><a href="API.en.html#section-5">Section IV. HTTP APIs & REST Architectural Principles</a></h4>
|
<h4><a href="API.en.html#section-5">Section IV. HTTP APIs & the REST Architectural Principles</a></h4>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="API.en.html#http-api-concepts">Chapter 33. On the HTTP API Concept and Terminology</a></li>
|
<li><a href="API.en.html#http-api-concepts">Chapter 33. On the HTTP API Concept and Terminology</a></li>
|
||||||
<li><a href="API.en.html#http-api-pros-and-cons">Chapter 34. Advantages and Disadvantages of HTTP APIs Compared to Alternative Technologies</a></li>
|
<li><a href="API.en.html#http-api-pros-and-cons">Chapter 34. Advantages and Disadvantages of HTTP APIs Compared to Alternative Technologies</a></li>
|
||||||
|
@ -16,7 +16,7 @@ Although the technology looks homogeneous because of using the same application-
|
|||||||
* Either the client-server interaction heavily relies on the features described in the HTTP standard (or rather standards, as the functionality is split across several different RFCs), or
|
* Either the client-server interaction heavily relies on the features described in the HTTP standard (or rather standards, as the functionality is split across several different RFCs), or
|
||||||
* HTTP is used as transport, and there is an additional abstraction level built upon it (i.e., the HTTP capabilities, such as the headers and status codes nomenclatures, are deliberately reduced to a bare minimum, and all the metadata is handled by the higher-level protocol).
|
* HTTP is used as transport, and there is an additional abstraction level built upon it (i.e., the HTTP capabilities, such as the headers and status codes nomenclatures, are deliberately reduced to a bare minimum, and all the metadata is handled by the higher-level protocol).
|
||||||
|
|
||||||
The APIs that belong to the first category are usually denoted as “REST” or “RESTful” APIs. The second category comprises different RPC formats and some service protocols, for example, SSH.
|
The APIs that belong to the first category are usually denoted as “REST” or “RESTful” APIs. The second category comprises mostly different RPC formats.
|
||||||
|
|
||||||
**Second**, different HTTP APIs rely on different data formats:
|
**Second**, different HTTP APIs rely on different data formats:
|
||||||
* REST APIs and some RPCs ([JSON-RPC](https://www.jsonrpc.org/), [GraphQL](https://graphql.org/), etc.) use the [JSON](https://www.ecma-international.org/publications-and-standards/standards/ecma-404/) format (sometimes with some additional endpoints to transfer binary data)
|
* REST APIs and some RPCs ([JSON-RPC](https://www.jsonrpc.org/), [GraphQL](https://graphql.org/), etc.) use the [JSON](https://www.ecma-international.org/publications-and-standards/standards/ecma-404/) format (sometimes with some additional endpoints to transfer binary data)
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"author": "Sergey Konstantinov",
|
"author": "Sergey Konstantinov",
|
||||||
"chapter": "Chapter",
|
"chapter": "Chapter",
|
||||||
"toc": "Table of Contents",
|
"toc": "Table of Contents",
|
||||||
"description": "API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & REST architectural principles, SDKs and UI libraries, API product management.",
|
"description": "API-first development is one of the hottest technical topics nowadays since many companies have started to realize that APIs serves as a multiplier to their opportunities — but it amplifies the design mistakes as well. This book is written to share expertise and describe best practices in designing and developing APIs. It comprises six sections dedicated to the following topics: the API design, API patterns, maintaining backward compatibility, HTTP APIs & the REST architectural principles, SDKs and UI libraries, API product management.",
|
||||||
"publisher": "Sergey Konstantinov",
|
"publisher": "Sergey Konstantinov",
|
||||||
"copyright": "© Sergey Konstantinov, 2023",
|
"copyright": "© Sergey Konstantinov, 2023",
|
||||||
"locale": "en_US",
|
"locale": "en_US",
|
||||||
@ -79,7 +79,7 @@
|
|||||||
"<ul><li>The API design</li>",
|
"<ul><li>The API design</li>",
|
||||||
"<li>API patterns</li>",
|
"<li>API patterns</li>",
|
||||||
"<li>Backward compatibility</li>",
|
"<li>Backward compatibility</li>",
|
||||||
"<li>HTTP APIs & REST architectural principles</li>",
|
"<li>HTTP APIs & the REST architectural principles</li>",
|
||||||
"<li>SDKs and UI libraries</li>",
|
"<li>SDKs and UI libraries</li>",
|
||||||
"<li>API product management.</ul>",
|
"<li>API product management.</ul>",
|
||||||
"<p class=\"text-align-left\">Illustrations & inspiration by Maria Konstantinova · <a href=\"https://www.instagram.com/art.mari.ka/\">art.mari.ka</a></p>",
|
"<p class=\"text-align-left\">Illustrations & inspiration by Maria Konstantinova · <a href=\"https://www.instagram.com/art.mari.ka/\">art.mari.ka</a></p>",
|
||||||
@ -101,7 +101,7 @@
|
|||||||
"<ul><li>— The API design</li>",
|
"<ul><li>— The API design</li>",
|
||||||
"<li>— API patterns</li>",
|
"<li>— API patterns</li>",
|
||||||
"<li>— Backward compatibility</li>",
|
"<li>— Backward compatibility</li>",
|
||||||
"<li>— HTTP APIs & REST architectural principles</li>",
|
"<li>— HTTP APIs & the REST architectural principles</li>",
|
||||||
"<li>— SDKs and UI libraries</li>",
|
"<li>— SDKs and UI libraries</li>",
|
||||||
"<li>— API product management.</ul>",
|
"<li>— API product management.</ul>",
|
||||||
"<p>Illustration & inspiration: <a href=\"https://www.instagram.com/art.mari.ka/\">art.mari.ka</a>.</p>"
|
"<p>Illustration & inspiration: <a href=\"https://www.instagram.com/art.mari.ka/\">art.mari.ka</a>.</p>"
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
* либо клиент-серверное взаимодействие опирается на описанные в стандарте HTTP возможности (точнее было бы сказать, «стандартах HTTP», поскольку функциональность протокола описана во множестве разных RFC);
|
* либо клиент-серверное взаимодействие опирается на описанные в стандарте HTTP возможности (точнее было бы сказать, «стандартах HTTP», поскольку функциональность протокола описана во множестве разных RFC);
|
||||||
* либо HTTP утилизируется как транспорт, и поверх него выстроен дополнительный уровень абстракции (т.е. возможности HTTP, такие как номенклатура ошибок или заголовков, сознательно редуцируются до минимального уровня, а вся мета-информация переносится на уровень вышестоящего протокола).
|
* либо HTTP утилизируется как транспорт, и поверх него выстроен дополнительный уровень абстракции (т.е. возможности HTTP, такие как номенклатура ошибок или заголовков, сознательно редуцируются до минимального уровня, а вся мета-информация переносится на уровень вышестоящего протокола).
|
||||||
|
|
||||||
К первой категории относятся API, которые принято обозначать словом «REST» или «RESTful», а ко второй — все виды RPC, а также прикладные протоколы типа SSH.
|
К первой категории относятся API, которые принято обозначать словом «REST» или «RESTful». Вторая категория, в основном, представлена разными видами RPC-протоколов.
|
||||||
|
|
||||||
**Во-вторых**, реализации HTTP API опираются на разные форматы передаваемых данных:
|
**Во-вторых**, реализации HTTP API опираются на разные форматы передаваемых данных:
|
||||||
* REST API и некоторые RPC ([JSON-RPC](https://www.jsonrpc.org/), [GraphQL](https://graphql.org/)) полагаются в основном на формат [JSON](https://www.ecma-international.org/publications-and-standards/standards/ecma-404/) (опционально дополненный передачей бинарных файлов);
|
* REST API и некоторые RPC ([JSON-RPC](https://www.jsonrpc.org/), [GraphQL](https://graphql.org/)) полагаются в основном на формат [JSON](https://www.ecma-international.org/publications-and-standards/standards/ecma-404/) (опционально дополненный передачей бинарных файлов);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user