actix / actix/actix-website

Missing documentation regarding actix-web's default error responses

未關閉
#386 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
good-first-issue help-wanted
主要語言
HTML
星號
210
分支
283
平均合併
18 小時 33 分鐘
30 天內合併 PR
8

描述

Hi, this is issue is related to missing documentation thus it's not an actual bug report. I would be happy to move this discussion to whatever place is the best.

Actix.rs has no documentation regarding HTTP error responses which are a result of a failed extraction of data using an Extractor.
For example, when using the Json extractor, actix-web automatically responds with an HTTP error response containing "Failed to deserialize..." (can't remember the exact message) whenever the request can't be deserialized with serde.

I would expect a section in the "Extractors/Json" page describing this error, it's code, and the exact origin of the message contained in it's body, such as:
"If serde can't deserialize the data contained in json, a 400 response will be generated with details regarding the serde_json::Error result obtained from the deserializatione error"

This causes API specification problems and incongruencies since the API designer didn't think about the error responses which are automatically generated by actix, thus not manually implemented by the developers.

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。