Implement Problem Details for HTTP APIs (RFC 9457) for api errors

Đang mở
  • Có gì không ổn?
#495 2 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
java
Lĩnh vực
api, backend

Hướng nghiên cứu

Bắt đầu bằng cách đọc RFC 9457 và tài liệu tham khảo về Spring MVC Problem Details được liên kết trong issue, sau đó kiểm tra các phản hồi lỗi hiện tại của API và việc xử lý ngoại lệ. Công việc được xem là hoàn tất khi các lỗi API trả về các phản hồi mô tả tuân theo tiêu chuẩn đã chọn để frontend có thể hiển thị chúng cho người dùng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The API should return more descriptive errors, rather than just plain status code errors, such that the frontend can display this information in a more user friendly (and descriptive) manner.

A suggestion is to implement the well known RFC 9457 standard for this, as documented here: https://datatracker.ietf.org/doc/html/rfc9457
Spring (and other frameworks) also has out-of-the-box support for this, e.g.: https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-ann-rest-exceptions.html

As discussed in community meeting in August.

Ngôn ngữ chính
Java
Star
34
Fork
34
Merge trung bình
9 phút
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của InseeFrLab/onyxia-api

Tất cả issue của InseeFrLab/onyxia-api

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.