Read-only JSON API for the catalog

Abierto
  • ¿Algo no está bien?
#46 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
64/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Área
api, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
CSS
Estrellas
1
Forks
1
Merge medio
39 min
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NotADIM2/GameVault

Todos los issues de NotADIM2/GameVault

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.