Автор оригинала: Amandeep.
Начните написание Herit было довольно некоторое время, когда я тесно сотрудничал с некоторыми финансовыми учреждениями, несколькими банковскими песочниками из стран Северной и Северной Европы, и многие другие энтузиасты API-энтузиастов, наращивающих API для их расширения продукции и общую совместимость. Это правда, что, хотя пользовательский опыт и связанные с ними исследования определяют будущий успех продукта, как иначе можно было бы обеспечить плавный пользовательский опыт в реальном мире программного обеспечения, отличного от того, чтобы сосредоточиться на исчерпывающих сценариях, которые могут раскрыться в пользовательском опыте. И это включает в себя включение всех сценариев ошибок и соответствующих сообщений к конечным пользователям.
Когда RFC7807 Спец Первый прочитан, нельзя найти актуальность для конечных пользователей или UX-дизайнеров. Но в конце концов, это обязанность команды разработки, созданного интеграции API и Bestend, чтобы обеспечить компромисс опыта. Один из интересных стандартов, которые я пришел через несколько месяцев назад (я должен был быть честен здесь, я также знал до этого только стандартные коды HTTP-ответов в 2xx успеха, 3xx Redirect, ошибка клиента 4xx и ошибка сервера 5xx) была достаточно RFC 7807 И ответил на все возможные вопросы о том, как действительно возможен действительно интуитивный пользовательский опыт, несмотря на подключение внешних API и инфраструктур, могут идти нестабильные и их бета-фаза.
Само собой разумеется, если ваш продукт не выполняет предполагаемую функцию для конечных пользователей, он не может быть на рынке. Однако в сценариях проблемы/ошибки он много имеет значение, когда вы честно общаетесь с пользователями, чтобы понять, что именно произошло, то, что может быть точной причиной, если пользователи должны попробовать еще раз рано или поздно, или в противном случае должен быть привлечен возможность пользователю. доступный. <
Например, (не из перспективы RFC 7807), если пользовательский интерфейс выдает агрегированный вызов API, чей подсомы составляют, у вас есть два варианта (на первом месте агрегация API должна была быть всегда разумной): 1. либо сообщайте о частичном состоянии объекта на UI или 2. Полностью вызов полностью. Но там не могут быть оба пути! Аналогичные способы, если Post API имеет значение между тем, когда для возврата 200 (успех) или 201 (успешно создал новый объект), для пользовательского интервала становится намного проще определить, влияет на то, что его запросы вызывают влияние на ваши API. Также он остается в тесном контакте с тем, что происходит под сценой. Как следует удалить API? Может быть, 204 как код успеха, Хотя определенная критика 204 вы можете прочитать здесь
Достаточно справедливо, что было бит, играя в адвокат дьявола, пытаясь описать бедствие, который может чувствовать себя с выбором выбора кода ошибки, чтобы вернуться и отсутствовать, чтобы описать проблему к методу вызова. Но что, если проблема передается пользователю с типом JSON Schema, называемая проблемами JSON Type в стандартной спецификации RFC7807?
Во время усыновления rfc7807 я не мог быть более счастливее, когда я нашел команду Zalando в Github, упомянув ее, и развивая его для надлежащих отзывчивых сообщений об ошибках в их реализации Backend
Следуя приведенному примеру, приведенным в сам спецификации RFC 7087, насколько доверительно будет иметь такое сообщение об ошибке проблем («проблема — это тип») JSON AS:
HTTP/1.1 400 плохой запрос Content Type: приложение/проблема + JSON Content-Language: выделять
{«Тип»: «HTTPS://example.net/Validation-Error», «Название»: «Параметры вашего запроса не подтверждают. «,« Неверные-парамы »: [{« Имя »:« Возраст »,« Причина »:« Должно быть положительным целым числом »}, {« Имя »:« Цвет »,« Причина »:« Должен быть «зеленым» , «красный» или «синий» »}]} <
Какая часть ошибки выше вы не поняли? И если бы вы сделали, будет ли трудно сказать конечным пользователю? Если выше, был «400-плохим запросом» в виде случая ошибок, но все же вы хотели просматривать пользователя о том, что пошло не так в его запросе, насколько больно код ошибки для отображения сообщений об ошибках, а другие накладные расходы на сэкономит? Возможно, лучше предложить все разработчики API, чтобы начать приступить к отправке сообщений об ошибках API в соответствии с RFC7807. Это определенно будет стоить усилия, проведенные в правильном направлении создания ваших форумов API или истинной совместимости и интеграции.
PS: единственная критика RFC7807, которую можно иметь (если вы печатать мыло, грамотный), что это может выглядеть как наложение Cistalos Ограничения, но опять же, это как ответственность, так и доступные альтернативы иметь некоторые стандарты на месте для ответов ошибок API!
Оригинал: «https://www.codementor.io/@amandeepmidha/good-user-experience-and-api-success-both-require-clarity-in-api-responses-ag3m6764z»