Read-only JSON API for the catalog

Aperta
  • Qualcosa non va?
#46 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
64/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Ambito
api, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
CSS
Stelle
1
Fork
1
Merge medio
39m
PR unite (30g)
6

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NotADIM2/GameVault

Tutte le issue di NotADIM2/GameVault

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.