mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-01-23 17:53:04 +02:00
107 lines
3.0 KiB
HTML
107 lines
3.0 KiB
HTML
<html><head>
|
|
<meta charset="utf-8"/>
|
|
<title>Sergey Konstantinov. The API</title>
|
|
<meta name="author" content="Sergey Konstantinov"/>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=PT+Serif&family=PT+Sans&family=Inconsolata"/>
|
|
<style>body {
|
|
font-family: 'PT Serif';
|
|
font-size: 14pt;
|
|
text-align: justify;
|
|
}
|
|
|
|
@media screen {
|
|
body {
|
|
margin: 20px auto;
|
|
max-width: 60%;
|
|
}
|
|
}
|
|
|
|
@media print {
|
|
h1 {
|
|
margin: 4.5in 0 5.2in 0;
|
|
}
|
|
body {
|
|
font-size: 20pt;
|
|
}
|
|
}
|
|
|
|
.cc-by-nc {
|
|
background: transparent url(https://i.creativecommons.org/l/by-nc/4.0/88x31.png) 0 5px no-repeat;
|
|
padding-left: 92px;
|
|
}
|
|
|
|
code, pre {
|
|
font-family: Inconsolata, sans-serif;
|
|
}
|
|
|
|
code {
|
|
white-space: nowrap;
|
|
}
|
|
|
|
pre {
|
|
margin: 1em 0;
|
|
padding: 1em;
|
|
border-radius: .25em;
|
|
border-top: 1px solid rgba(0,0,0,.45);
|
|
border-left: 1px solid rgba(0,0,0,.45);
|
|
box-shadow: .1em .1em .1em rgba(0,0,0,.45);
|
|
page-break-inside: avoid;
|
|
}
|
|
|
|
pre code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.page-break {
|
|
page-break-after: always;
|
|
}
|
|
|
|
a {
|
|
text-decoration: none;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5 {
|
|
text-align: left;
|
|
font-family: 'PT Sans';
|
|
font-weight: bold;
|
|
page-break-after: avoid;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 200%;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 160%;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 140%;
|
|
}
|
|
|
|
h4, h5 {
|
|
font-size: 120%;
|
|
}
|
|
|
|
@page {
|
|
size: 8.5in 11in;
|
|
margin: 0.5in;
|
|
}
|
|
|
|
:root {
|
|
--main-font: 'PT Serif';
|
|
--alt-font: 'PT Serif';
|
|
--code-font: Inconsolata;
|
|
}</style>
|
|
</head><body>
|
|
<article><h1>Sergey Konstantinov<br/>The API</h1>
|
|
|
|
<p class="cc-by-nc">This work is licensed under a <a href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.</p>
|
|
<div class="page-break"></div><h2>Introduction</h2><h3 id="chapter1onthestructureofthisbook">Chapter 1. On the Structure of This Book</h3>
|
|
<p>The book you're holding in your hands comprises this Introduction and three large sections.</p>
|
|
<p>In Section I we are to talk about deisgning the API as a concept: how to build the architecture properly, from a high-level planning down to final interfaces.</p>
|
|
<p>Section II is dedicated to API's lifecycle: how interfaces evolve over time, and how to elaborate the product to match users' needs.</p>
|
|
<p>Finally, Section III is more about un-engineering sides of the API, like supporting, marketing and working with a community.</p>
|
|
<p>First two sections are much of of interest to engineers, when third section being more relevant to both engineers and product managers. But we insist that this section is the most important for the API software developer. Since API is the product for engineers, you cannot simply pronounce non-engineering team responsible for its product planning and support. Nobody but you understands more what product features your API is capable of.</p>
|
|
<p>Let's start.</p><div class="page-break"></div><h2>API Design</h2></article>
|
|
</body></html> |