Read-only JSON API for the catalog

オープン
#46 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
64/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
領域
api, documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
CSS
スター
1
フォーク
1
平均マージ
39分
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NotADIM2/GameVault のほかの issue

NotADIM2/GameVault の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。