Werner Vogels – अच्छे API डिज़ाइन के लिए सीखी गई 6 बातें
(aws.amazon.com)- "AWS ने 15 वर्षों में अच्छे API बनाने के लिए सीखे 6 सिद्धांत" पर नोट्स
-
API हमेशा के लिए होते हैं!
-
backward compatibility बनाए रखें।
-
ग्राहक के उपयोग मामलों से उल्टा सोचकर बनाइए।
-
ऐसे API बनाइए जिनमें errors स्पष्ट हों।
-
ऐसे API बनाइए जिनका उद्देश्य और उपयोग का तरीका तुरंत समझ में आ जाए।
-
implementation details बाहर लीक न हों, इसका ध्यान रखें।
-
शुरुआती API डिज़ाइन में होने वाली गलतियाँ
-
Smithy के जरिए highly extensible API बनाना
4 टिप्पणियां
मुझे 5वां बिंदु सबसे ज़्यादा प्रभावित कर गया।
जिस "क्या ऐसा REST API ठीक है" का संदर्भ दिया गया है, उसे मैंने पहले देखा था और वह अच्छा लगा था: https://tv.naver.com/v/2292653
मैं आमतौर पर ऐसी semantic? जानकारी पर ध्यान नहीं देता, लेकिन Github API को देखें तो वह ऐसी जानकारी भी अच्छी तरह देता है, इसलिए यह एहसास होता है कि उसे अच्छी तरह बनाया गया है.
लगता है कि यह काफ़ी अच्छी सामग्री है.
खासकर 1 और 4 नंबर वे बिंदु लगते हैं जिनकी बात हम रिव्यू करते समय हमेशा करते हैं.
3 नंबर Joshua Bloch की कही हुई बात "Write to Your API Early and Often" से जुड़ा हुआ हिस्सा लगता है. (https://www.youtube.com/watch?v=aAb7hSCtvGw)
इसे इस तरह व्यवस्थित करके रखो तो यह स्वाभाविक सा लगता है, लेकिन असल में करते समय बार-बार वही गलतियाँ दोहराई जाती हैं, ऐसा ही लगता है।