mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-05-25 22:08:06 +02:00
45 lines
2.4 KiB
Markdown
45 lines
2.4 KiB
Markdown
# Read [‘The API’ Book by Sergey Konstantinov](https://twirl.github.io/The-API-Book) in English
|
|
# Читать [книгу ‘The API’ Сергея Константинова](https://twirl.github.io/The-API-Book/index.ru.html) по-русски
|
|
|
|
This is the working repository for ‘The API’ book written by Sergey Konstantinov ([email](mailto:yatwirl@gmail.com), [Linkedin profile](https://linkedin.com/in/twirl), [Medium blog](https://twirl.medium.com)).
|
|
|
|
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.
|
|
|
|
This book is written to share the expertise and describe the best practices in designing and developing APIs. It comprises six sections dedicated to:
|
|
* the API design
|
|
* API patterns
|
|
* backwards compatibility
|
|
* HTTP API & REST
|
|
* SDK and UI libraries
|
|
* API product management.
|
|
|
|
This is an open-source book distributed under the [Creative Commons Attribution-NonCommercial 4.0 International](/LICENSE.md) license.
|
|
|
|
## Current State and the Roadmap
|
|
|
|
Right now three sections (‘The API Design’, ‘The Backwards Compatibility’, and ‘The API Product’) are finished, comprising the [first edition of the book](/docs/v1/). Three other sections are drafted and are now being added to the clean copy chapter after chapter.
|
|
|
|
Also, the book still lacks readable schemes which I'm still planning to plot with mermaid.
|
|
|
|
## Translation
|
|
|
|
I am translating new chapters into English at the moment they're ready. I'm not a native speaker, so feel free to correct my grammar.
|
|
|
|
## Contributing
|
|
|
|
I am accepting inquiries. Feel free to open issues.
|
|
|
|
I am NOT accepting pull requests introducing any new content, since I'm willing to be the only author. I would gratefully accept typo fixes, though.
|
|
|
|
Thanks [art.mari.ka](https://www.instagram.com/art.mari.ka/) for the illustration & inspiration.
|
|
|
|
Thanks [Ilya Subbotin](https://ru.linkedin.com/in/isubbotin) and [Fedor Golubev](https://www.linkedin.com/in/fedor-golubev-93910b5/) for the valuable feedback.
|
|
|
|
Thanks @tholman for https://github.com/tholman/github-corners.
|
|
|
|
Thanks [Ira Gorelik](https://pixabay.com/users/igorelick-680927/) for the Aqueduct.
|
|
|
|
Thanks [ParaType](https://www.paratype.ru/) for PT Sans and PT Serif.
|
|
|
|
Thanks [Christian Robertson](https://twitter.com/cr64) for Roboto Mono.
|