Избавиться от полей Success и Answer в пользу кодов ответов #4

New Issue

dm1sh · 2023-07-12T17:21:42+03:00

dm1sh commented

2023-07-12 17:21:42 +03:00

В get("/api/announcements") лучше возвращать сразу list'ом result, а ошибки через HTTP status code отсылать (404 или 5xx).
То же самое в get("/api/announcement") - там в except лучше возвращать 404
На put("/api/announcement") и post("/api/signup") можно возвращать 201 Created, либо код ошибки.
Для delete("/api/announcement") и post("/api/book") в случае неудачи лучше что-то вразумительное из диапазона 4xx или 5xx

Для отсылки успешных status code'ов можно делать так https://fastapi.tiangolo.com/tutorial/response-status-code/
А для ошибок вот так https://fastapi.tiangolo.com/tutorial/handling-errors/

Это не только унифицирует код обработки ошибок на фронте, но и сделает проще мониторинг запросов - в логах сразу будет видно, что кто-то массово перебирает несуществующие объявления

Всё вышеизложенное не является правдой в последней инстанции, поэтому приглашаю к обсуждению

В get("/api/announcements") лучше возвращать сразу list'ом result, а ошибки через HTTP status code отсылать ([404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) или [5xx](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses)). То же самое в get("/api/announcement") - там в except лучше возвращать 404 На put("/api/announcement") и post("/api/signup") можно возвращать [201 Created](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201), либо код ошибки. Для delete("/api/announcement") и post("/api/book") в случае неудачи лучше что-то вразумительное из диапазона 4xx или 5xx Для отсылки успешных status code'ов можно делать так https://fastapi.tiangolo.com/tutorial/response-status-code/ А для ошибок вот так https://fastapi.tiangolo.com/tutorial/handling-errors/ Это не только унифицирует код обработки ошибок на фронте, но и сделает проще мониторинг запросов - в логах сразу будет видно, что кто-то массово перебирает несуществующие объявления Всё вышеизложенное не является правдой в последней инстанции, поэтому приглашаю к обсуждению

dm1sh added the

back

label 2023-07-12 17:21:42 +03:00

vova was assigned by dm1sh

2023-07-16 15:38:24 +03:00

dm1sh closed this issue

2023-09-14 17:14:36 +03:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: polka_billy/porridger#4