- एकरूपता बनाए रखें: URL/हेडर/ऑथेंटिकेशन/स्टेटस कोड..
- ISO8601 UTC तारीख फ़ॉर्मैट का उपयोग करें
- केवल Public Endpoint पर ऑथेंटिकेशन की छूट हो। बाकी सभी के लिए ऑथेंटिकेशन अनिवार्य हो
- हेल्थ चेक Endpoint उपलब्ध कराएँ
- API versioning
- API key ऑथेंटिकेशन लागू करें
- उचित HTTP स्टेटस कोड और मेथड का उपयोग करें
- हर Endpoint के लिए ऐसा सरल नाम उपयोग करें जो अपने आप में स्पष्ट हो
- मानक error response का उपयोग करें
- POST में बनाए गए resource को लौटाएँ
- PUT की जगह PATCH
- जितना संभव हो उतना विशिष्ट रहें
- Pagination का उपयोग करें
- हर resource को विस्तार योग्य बनाएँ (जैसे
expand जैसे query param देकर अतिरिक्त जानकारी भी लौटाई जा सके, ऐसा डिज़ाइन करें)
2 टिप्पणियां
मैंने हाल में इससे जुड़ी बातें कई जगह देखी हैं, और मैं "रोज़मर्रा की चीज़ें जो वेब API डिज़ाइन को समझाती हैं" की सिफारिश करता हूँ। शीर्षक और कवर की वजह से इसे इंटरनेट के लिए किसी आसान रूपक-आधारित किताब समझा जा सकता है, लेकिन यह API design को पेशे के रूप में करने वाले लेखक की गहरी समझ और अंतर्दृष्टि दिखाने वाली एक अच्छी पुस्तक है।
Microsoft REST API दिशानिर्देश
Stackoverflow के REST API दिशानिर्देश