В настоящее время я пишу API/некоторые клиенты для шахматных игр.
Разработчики должны получить доступ к API через один script (xhrframework.php) и отправить действия через GET. Возможно, что они совершают некоторые ошибки при отправке действий (никаких отправленных PHPSESSID, недействительных PHPSESSID, перемещение недействительно, это не их очередь,...).
Итак, я подумал о возможностях отображения ошибок. Я придумал некоторые идеи, как сообщить программисту, что он сделал ошибку:
- через сообщение об ошибке на понятном английском языке
- +: ясно, что должна означать ошибка
- +: информация о том, как исправить эту ошибку, можно добавить
- -: сообщение может измениться, так как мой английский не очень хорош
- -: Длина сообщения отличается довольно много - это может быть важно для программистов C.
- через ab сообщение об ошибке постоянное на английском языке - что-то вроде WRONG_PHPSESSID, MISSING_PHPSESSID, INVALID_MOVE, NOT_YOUR_TURN,...
- +: Это понятно для человека
- 0: он почти уверен, что сообщение не меняет
- -: длина сообщения может немного отличаться
- через код ошибки с одной таблицей в документации, где программист может найти значение кода ошибки
- +: код ошибки будет постоянным
- +: длина каждого кода ошибки может быть одинаковой.
- -: Это загадочный
Я хочу, чтобы третье решение могло быть хорошей идеей, так как xhrframework.php должен получить доступ только программистом, который вполне мог взглянуть на документацию API.
Теперь я хотел бы знать, существует ли стандарт для сообщений Web-API-Error. Как другие (например, API Карт Google) разрешают это? Должен ли я просто выводить пустую страницу с содержимым "ERROR: 004" или без заполнения "ERROR: 4"?
Какие ошибки должны получать номера? Имеет смысл группировать ошибки по их числам, например. все ошибки, начинающиеся с 1, были ошибками аутентификации, все ошибки с двумя ошибками логики игры? Было бы лучше начать с ошибки 1 и использовать каждый номер?
API Карт Google
Если я создаю неправильный вызов в JS-API Google Maps, он возвращает Java- Script с сообщением на ясном немецком ( как я живу в Германии, я думаю).
Google Static Maps API возвращает сообщение как текст на понятном английском языке, если я делаю неправильный вызов .