mirror of
https://github.com/twirl/The-API-Book.git
synced 2025-05-19 21:33:04 +02:00
syntax
This commit is contained in:
parent
5ac95220c0
commit
f69a96c19a
@ -6,9 +6,9 @@ One of the most important tasks for an API developer is to ensure that code writ
|
||||
|
||||
**NB**: the examples in this chapter are meant to illustrate the consistency and readability problems that arise during API development. We do not provide specific advice on designing REST APIs (such advice will be given in the corresponding section of this book) or programming languages' standard libraries. The focus is o the idea, not specific syntax.
|
||||
|
||||
An important assertion at number 0:
|
||||
An important assertion number one:
|
||||
|
||||
##### 0. Rules Must Not Be Applied Unthinkingly
|
||||
##### Rules Must Not Be Applied Unthinkingly
|
||||
|
||||
Rules are simply formulated generalizations based on one's experience. They are not to be applied unconditionally, and they do not make thinking redundant. Every rule has a rational reason to exist. If your situation does not justify following a rule, then you should not do it.
|
||||
|
||||
|
@ -6,9 +6,9 @@
|
||||
|
||||
**NB**: примеры, приведённые в этой главе, прежде всего иллюстрируют проблемы консистентности и читабельности, возникающие при разработке API. Мы не ставим здесь цели дать рекомендации по разработке REST API (такого рода советы будут даны в соответствующем разделе) или стандартных библиотек языков программирования — важен не конкретный синтаксис, а общая идея.
|
||||
|
||||
Важное уточнение под номером ноль:
|
||||
Важное уточнение номер один:
|
||||
|
||||
##### 0. Правила не должны применяться бездумно
|
||||
##### Правила не должны применяться бездумно
|
||||
|
||||
Правило — это просто кратко сформулированное обобщение опыта. Они не действуют безусловно и не означают, что можно не думать головой. У каждого правила есть какая-то рациональная причина его существования. Если в вашей ситуации нет причин следовать правилу — значит, следовать ему не нужно.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user