Read-only JSON API for the catalog

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

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
64/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Start from the existing store listing code that applies the filters, since the new endpoints must reuse them, and from the schema/models to see which fields belong to the games catalog versus users. Then add the two read-only routes and confirm with a couple of requests that paging and filtering behave like the store, and that no user field leaks. Done means both endpoints return only public game fields and the README lists the endpoints with their parameters.

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

Mô tả

backend help wanted

Add a small public API so others can build on the catalog.

  • GET /api/games with the same filters as the store, plus paging
  • GET /api/games/<id>
  • Return only public catalog fields. Never return anything from users.
  • Document the endpoints in the README
Ngôn ngữ chính
CSS
Star
1
Fork
1
Merge trung bình
39 phút
Pull request đã merge (30 ngày)
6

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

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 NotADIM2/GameVault

Tất cả issue của NotADIM2/GameVault

Issue tương tự

Thêm issue về Backend & API Design

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.