システムへのWeb APIの作成

こんにちは、％ユーザー名％！

過去1年間、私はさまざまなサービスの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 — , .