अपने सिस्टम में एक वेब एपीआई लिखना

शुभ दोपहर,% उपयोगकर्ता नाम%!

पिछले एक साल में, मैंने विभिन्न सेवाओं के लिए SOAP / REST API लिखने के कई कार्यों का सामना किया है और अधिक या अधिक सुविधाजनक मॉडल के साथ आया हूं। मैं एक मौलिक अध्ययन करने का नाटक नहीं करता, मैं सिर्फ एक रेक पर कदम रखने के अनुभव को साझा करना चाहता हूं।



सबसे पहले, डिफ़ॉल्ट API के लिए सामान्य आवश्यकताएं:

• विस्तार करने के लिए अवसर
• सुविधाजनक मानकीकृत अनुरोध प्रारूप
• सुविधाजनक मानकीकृत प्रतिक्रिया प्रारूप
• पर्याप्त सुरक्षा
• वापसी क्वेरी निष्पादन त्रुटियाँ

API (PHP/Perl/Python et), UI (JS). , .

JSON. XML, API JavaScript — ?



:

cmd=" "&data="JSON "&sig=" , "





:

cmd — , . , auth, profile, edit, view — . JSON, JSON .

data — JSON.

sig — , . , - : md5(cmd+secret+data), secret — , ( , ), .

- (AJAX-JavaScript) — secret cookie .



:

{

status: "ok error - "

response: " "

error: " 0 "

}







, .

. :

1. , , cmd
2. — (sig) — ,
3. ,
4. —

, , , . , , .



, :

1. Manager — ,
2. Module — . , , , , Registry, , ,
3. Registry — , — Manager.
4. Response — , , . (JSON )
5. -

, — Registry Response.



, :

• auth — API
• log_out —
• user —
• view —
• list —
• add —
• edit —
• del —

, .



API , . , .



UPD: REST SOAP API. , . REST — , .