Что обозначает код ошибки

Пример кода статуса в заголовке curl

Коды статусов не отображаются в тебе ответа. Они содержатся в хэдере, который может быть не видим по умолчанию.

Заголовок ответа выглядит следующим образом:

Коды состояния довольно тонкие, но когда разработчик работает с API, коды могут быть единственным «интерфейсом», который имеет разработчик. Если получится контролировать сообщения, которые видит разработчик, это будет большой победой юзабилити

Слишком часто коды состояния неинформативны, плохо написаны и сообщают мало или вообще никакой полезной информации пользователю для преодоления ошибки. По большому счету, коды состояния должны помогать пользователям в восстановлении после ошибок.

Можно посмотреть список общих кодов состояния REST API здесь и общий список кодов HTTP статусов здесь. Хотя, возможно, было бы полезно включить несколько стандартных кодов состояния, нет необходимости в полном документировании всех стандартных кодов состояния, особенно если они редко запускаются в API.

Где перечислять HTTP-ответ и коды ошибок

Практичнее, если API будут иметь одну страницу с ответами и кодами ошибок ко всему API. Отдельная страница с перечнем кодов состояния (вместо добавления кода состояния в каждую конечную точку) позволяет более детально описать каждый код без переполнения других частей документации. Такой подход уменьшает избыточность и ощущение информационной перегрузки.

С другой стороны, если какие-то коды состояния и ошибок больше подходят к определенным конечным точкам, чем другие, имеет смысл вывести такие коды состояния и ошибок на страницы с описаниями конечных точек.

Такая стратегия может заключаться в том, чтобы привлечь внимание к каким-либо особенно важным кодам состояния или ошибок для конкретной конечной точки, а затем перейти к централизованной странице «Коды ответов и состояний» для получения полной информации.

Где взять коды ошибок и статусы

Коды состояния и ошибок могут быть неочевидны в документации API. Вероятно, придется попросить разработчиков предоставить список всех кодов состояния и ошибок, которые уникальны для API. Иногда разработчики хардкодят коды состояния и ошибок непосредственно в программном коде, и у них нет простых способов передать полный список (что также затрудняет локализацию).

В результате может потребоваться танцы с бубнами, чтобы найти все коды. В частности, возможно придется сломать API, чтобы увидеть все возможные коды ошибок. Например, если превысить ограничение скорости для определенного запроса, API может вернуть специальную ошибку или код состояния. Такой пользовательский код обязательно нужно задокументировать. В разделе устранения неполадок в API можно специально разместить примеры получения кодов ошибок.

Как перечислять коды ошибок

Коды статусов и ошибок можно привести в виде списка определений или таблицы, например так:

Коды состояния и ошибок помогают в устранении неполадок

Коды состояния и ошибок особенно полезны при устранения неполадок. Таким образом, можно рассматривать коды ошибок как дополнение к разделу по устранению неполадок.

Каждая часть документации может быть полезна в разделе, посвященном устранению неполадок. В разделе, посвященном устранению неполадок, можно описать, что происходит, когда пользователи уходят с проторенной дорожки и спотыкаются в темном лесу. Коды состояния похожи на подсказки, которые помогут пользователям вернуться на правильный путь.

В разделе по устранению неполадок можно перечислить сообщения об ошибках, связанных со следующими ситуациями:

текст ошибки должен точно документироваться, чтобы она легко появлялась при поиске.

Примеры кодов статусов и ошибок

Ниже приведены несколько вариантов разделов с кодами статусов и ошибок.

Context. io

Clearbit не только документирует стандартные коды состояния, но также описывает уникальные параметры, возвращаемые их API. Большинство разработчиков, вероятно, знакомы с кодами 200, 400 и 500, поэтому эти коды не требуют много пояснений. Но если API имеет уникальные коды, описывать их нужно адекватно и подробно.

Twitter

В Twitter не только описывается код и состояние, но также предоставляется полезная информация по устранению неполадок, потенциально помогая в устранении ошибок. Например, про ошибку 500 не просто сказано, что статус относится к неработающей службе, но и есть объяснение: «Обычно это временная ошибка, например, в ситуации высокой нагрузки или если у конечной точки временно возникают проблемы. Посетите форумы разработчиков на случай, если у других возникнут аналогичные проблемы, или повторите попытку позже».

Mailchimp

Mailchimp предоставляет удобочитаемые и понятные описания сообщений об ошибке. Например, в ошибке 403 вместо того, чтобы просто написать «Запрещено», Mailchimp объясняет причины, по которым можно получить ошибку запрещенного кода. У Mailchimp существует несколько типов ошибок 403. Запрос может быть запрещен из-за отключенной учетной записи пользователя или запроса, направленного не в тот центр обработки данных. В случае ошибки «WrongDataCenter» Mailchimp отмечает, что «она часто связана с неправильно настроенными библиотеками» и ссылается на дополнительную информацию о центрах обработки данных. Такой тип документации кода ошибки очень полезен для пользователей.

Flickr

В Flickr раздел «Коды ответов» встроен в описание каждой адресной темы API. Описания ошибок выглядят короткими. Хотя встраивание кодов ответов в каждую тему делает коды ошибок более заметными, в некоторых случаях такой подход менее полезен. Поскольку он встроен в каждую тему API, описания кодов ошибок должны быть краткими, иначе их содержимое будет перегружено информацией о запросе конечной точки.

Напротив, отдельная страница с перечнем кодов ошибок позволяет более подробно раскрывать каждый код, не вытесняя другую документацию. Отдельная страница также уменьшает избыточность и увеличивает объем информации.

?‍? Практическое занятие: Коды статусов и ошибок

В своем найденном опен-сорс проекте найдем информацию о кодах статусов и ошибок. Ответим на следующие вопросы:

Почему появляется ошибка в Сервисы Гугл Плей и как исправить ее

Владельцы мобильных устройств Android прекрасно знают, что для скачивания любого официального контента нужно зайти в сервис Google Play. Здесь выложены разные приложения, помогающие ускорить работу системы, антивирусы на любой вкус, игры и другие очень полезные инструменты для работы и развлечений. Но часто на экране появляется сообщение, что в приложении сервисы Google Play произошла ошибка. Обычно вместе с этим грустным сообщением указывается код, по нему можно определить причину, по которой сервис не может работать. Давайте разбираться, какие ошибки бывают и как исправить их самостоятельно.

Из статьи вы узнаете

Простое сообщение без нумерации

Это очень распространенная причина, которая может возникнуть из-за конфликта версии сервиса Гугл Плей c самой версией ОС устройства, или из-за возникшего сбоя в работе Маркета.

Если ваш телефон или планшет предупредил о неизвестной ошибке, то есть без указания кода, то можно попробовать ее устранить самостоятельно, проделав следующие шаги:

В большинстве случаев этот способ устраняет возникшие неполадки в работе сервиса, но если этого не произошло, то можно решить проблему простым удалением его из системы, а после этого нужно загрузить и установить последнюю версию Маркета.

Неизвестная ошибка очень часто возникает из-за неверной установки даты и времени. Устранить несоответствие можно также из системных настроек в одноименной графе – можно выбрать синхронизацию с интернетом в автоматическом режиме или задать нужные значения вручную.

Также причиной может служить отсутствие выхода в интернет, и если вы используете беспроводные сети, то проверьте пароль входа и свой логин, вполне вероятно, что после исправления вы сможете войти на страницу сервисной службы Google Play.

Нумерованные ошибки

Если на экране своего устройства вы видите номер ошибки Сервисы Гугл Плей, то это поможет идентифицировать возникшую проблему, и быстро исправить ее. Далее приводим список самых частых ошибок и даем конкретные советы, что делать в том или ином случае.

Эта неполадка может быть спровоцирована неправильной установкой сервисной службы, когда пользователь решил вначале удалить, а потом установить вновь службу Маркета. Дело в том, что в таком случае в системе остаются много следов, не удаленных папок, которые и не дают сделать правильную установку, то есть вызывают конфликт.

Вообще-то неполадкой это назвать нельзя, просто система вам, таким образом, сообщает о недостаточности места в памяти вашего устройства. Google Play – системное приложение, и оно обязательно должно быть установлено в память самого устройства, и если места недостаточно, то выскакивает сообщение об этой ошибке.

Чтобы система работала без сбоев сделайте следующее:

Много места занимают и записи кэша, и хорошо было бы от них освободиться, как чистить устройство мы рассказали на примере выше.

Эта проблема может появиться из-за наличия сразу нескольких аккаунтов Google, и на самом устройстве, и в сервисах. Что бы решить проблему, из основной учетной записи войдите в настройки, и удалите сервис, а затем вновь установите его. Проблем не должно быть.

Также могут возникать неполадки из-за подключения к прокси-серверу (используется для открытия запрещенных в России сайтов), при перенаправлении в другую страну получить обновления невозможно, поэтому выскакивает номер именно этой неполадки. Чтобы избавиться от возникшей проблемы следует вначале остановить работу Cервисов Google, а затем очистить все данные.

Эта неполадка появляется во время неправильного определения созданного аккаунта, и чтобы от нее избавиться, вначале нужно удалить неправильную учетную запись, а потом вновь создать ее на своем устройстве. После удаления не забудьте перезагрузить ваше устройство, чтобы изменения вступили в силу!

Эта ошибка сервисов Гугл Плэй связана с отсутствием возможности удаления и переустановки приложения из конкретной учетной записи.

В этом случае произошел сбой виртуальной машины Dalvik, которая использует программное обеспечение под управлением Java. И в этом случае, в принципе, как и первое действие во всех остальных, нужно очистить все записи созданного кэша в сервисных службах Google Play и Play Market из главного меню настроек. Поочередно проведите зачистку и сделайте рестарт.

Если эти действия не привели к успеху, то можно сбросить все настройки устройства до заводских значений, из главного меню настроек. Если есть ценная информация, то перенесите ее на карту памяти или компьютер, и только потом делайте сброс.

Ошибка с кодом rh-01

В последнее время это довольно распространенная проблема. Решается несколькими способами. Об этом мы писали в статье « Устраняем ошибку rh-01 ».

Выводы

Эти и другие виды ошибок в большинстве случаев исправляются зачисткой записей КЭШа. Ну а такой вид, как № 911 связан с неудачной попыткой выхода в интернет через беспроводную сеть Wi-Fi, здесь нужно только проверить все настройки, и задать новые значения для входа.