Obecnie piszę API/niektórych klientów do gier szachowych.Czy istnieje standard dla kodów błędów/błędów?
Twórcy powinni uzyskać dostęp do interfejsu API za pomocą jednego skryptu (xhrframework.php) i przesłać akcje za pośrednictwem GET. Możliwe, że popełniają błędy podczas przesyłania akcji (Nie wysłano PHPSESSID, brak prawidłowego PHPSESSID, ruch był nieważny, to nie jest ich kolej, ...).
Więc pomyślałem o możliwościach wyświetlania błędów. Wpadłem na kilka pomysłów, jak informują programator, że popełnił błąd:
- za pomocą komunikatu o błędzie w jasny angielski
- +: Jest oczywiste, co błąd powinno oznaczać
- + : informacje, jak naprawić ten błąd może być dodany
- -: komunikat może się zmienić jak mój angielski nie jest zbyt dobry
- -: długość wiadomości różni się całkiem sporo - może to być ważne dla programistów C
- poprzez ab komunikat o błędzie stałej po angielsku - coś podobnego WRONG_PHPSESSID, MISSING_PHPSESSID, INVALID_MOVE, NOT_YOUR_TURN ...
- +: To zrozumiałe dla człowieka
- 0: To prawie pewny, że wiadomość nie robi „t zmienić
- -: długość wiadomości może się różnić nieco
- poprzez kod błędu z jednej tabeli w dokumentacji, w którym programista może znaleźć znaczenia kodu błędu
- +: Kod błędu byłby stały
- +: długościach każdego kodu błędu może być taka sama
- -: To tajemnicze
I thoguht trzecie rozwiązanie może być dobrym pomysłem, ponieważ xhrframework.php powinien być dostępny tylko przez programistę, który całkiem nieźle już zapoznał się z dokumentacją API.
Teraz chciałbym wiedzieć, czy istnieje standard dla komunikatów o błędach Web-API. W jaki sposób inni (np. Google Maps API) to rozwiązali? Czy powinienem wypisać po prostu pustą stronę z treścią "BŁĄD: 004" lub bez dopełnienia "BŁĄD: 4"?
Które błędy powinny otrzymać liczby? Czy ma sens grupowanie błędów według ich numerów, np. wszystkie błędy zaczynające się od 1 to błędy uwierzytelnienia, wszystkie błędy z dwoma błędami logiki gry? Czy lepiej zacząć od błędu 1 i użyć każdego numeru?
Google Maps API
Jeśli zrobię wrong call do Google Maps API JS, zwraca Java-Script z komunikatem w wyraźnym niemieckim (jak ja mieszkam w Niemczech, chyba).
Google Static Maps API zwraca komunikat w postaci tekstu w przejrzystym języku angielskim, jeśli utworzę wrong call.
Wiem tylko: http://en.wikipedia.org/wiki/HRESULT – Flo
Dzięki Flo. Ponieważ nie programuję na komputerze z systemem Windows, nie pomaga mi to wiele, ale dało mi to pojęcie, w jaki sposób mogę utworzyć niestandardowy komunikat o błędzie. Nie myślałem o dodawaniu wagi do mojego kodu błędu. –
Albo, dla nie-MS-owej części świata, mamy [http://en.wikipedia.org/wiki/Errno.h] –