Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

API - send/receive API version as header

Đang mở
#591 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 7 ngày

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ệ
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Bắt đầu bằng việc đọc changelog phiên bản trong docs/CALENDAR_API.md. Làm rõ liệu các request và response có sử dụng các phiên bản major hay không, mã trạng thái nào được áp dụng cho các phiên bản không được hỗ trợ, và liệu server có mặc định sử dụng phiên bản mới nhất hay không. Được coi là hoàn tất khi hành vi thương lượng phiên bản đã thống nhất được ghi lại và triển khai cùng với proof of concept cho v1 và v2.

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

Mô tả

API backend enhancement frontend

The API should include the version number as a header in responses, e.g.

API-Version: 3

(Major version number only?)

Clients would also be encouraged (though not required) to include the version they're using in requests. If the client doesn't specify, the server would assume the latest version. In the future we may rev the version and introduce breaking changes, so clients should send the version they're expecting to ensure a predictable response.

As a proof of concept for handling different versions, we could check for v1 or v2 requests and reject those. (There should be no real requests for those versions, because those version numbers were defined post-hoc well after we were already on v3.) Error status code could be 400, or possibly 406 (Not Acceptable).

Ngôn ngữ chính
JavaScript
Star
30
Fork
26
Merge trung bình
6 ngày 23 giờ
Pull request đã merge (30 ngày)
3

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 shift-org/shift-docs

Tất cả issue của shift-org/shift-docs

Issue tương tự

Thêm issue về JavaScript

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.