actix / actix/actix-website

Missing documentation regarding actix-web's default error responses

Abierto
#386 3 comentarios 0 reacciones 0 asignados Ver en GitHub
good-first-issue help-wanted
Lenguaje dominante
HTML
Estrellas
210
Forks
283
Merge medio
18 h 33 min
PR fusionados (30 d)
8

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.