Dobre praktyki dotyczące projektowania interfejsu API opartego na sieci Web

Question

W chwili obecnej wdrażamy interfejs API oparty na WebSocket w naszym application.

Do tej pory oferujemy REST API, a także interfejs API XMPP i spodziewamy się oferować podobne funkcje, ale nie jesteśmy pewni co do jego konstrukcji.

Będziemy używać formatu danych JSON, ale to jest jedyna rzecz, którą wiemy na pewno. Czy są na to jakieś dobre praktyki?

Na przykład interfejs API REST ma ogromną zaletę polegającą na użyciu czasowników HTTP i zasobów URL w celu opisania, co zostało zrobione. Websocket nie ma żadnego z nich. Po nawiązaniu połączenia URL staje się nieistotny.

Czy ktoś wie o istniejących API opartych na websocket?

Answer 1

Tak, istnieje: here.

[edit: martwy link Wiki usunięte]

Answer 2

Oto kilka websocket oparte API/protokoły:

Pusher

Slack Real Time Messaging

Wydaje większość osób, które są klient JS stoi używają jakiegoś zdarzenia/polecenia sparowanego z obiektem danych. Dodatkowo, Slack ma pomysł, aby wiadomość id była powiązana z komunikatami żądania i odpowiedzi.