Documenter l'API REST du backend (docs/API.md)

Abierto
#92 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
58/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
go, openapi

Línea de trabajo

Start with backend/main.go to enumerate registered routes, then inspect backend/api/handler/ and backend/api/service/ for access requirements and exact payload structures. Check the apierror format and invitation flow, then link the finished API reference from the README’s Documentation section. Done means every route, required header and minimum role, mutation example, error format, and end-to-end invitation flow is documented.

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

Descripción

documentation good first issue

Objectif

Produire la documentation complète des endpoints REST exposés par le backend Go. Ce document sert de contrat d'interface entre le frontend et le backend, et de point d'entrée pour toute intégration tierce.

User story

En tant que développeur frontend ou intégrateur, je veux consulter la liste exhaustive des routes, leurs payloads et les en-têtes attendus, afin d'appeler l'API correctement sans lire le code Go.

Tâches

  1. Créer docs/API.md. Une spécification OpenAPI est également acceptable si le contributeur préfère.
  2. Recenser les routes — analyser backend/main.go, où toutes les routes sont enregistrées, et le dossier backend/api/handler/. Couvrir /api/auth/*, /api/bands/*, /api/song/*, /api/setlist/*, /api/interlude/*.
  3. Documenter l'authentification — indiquer clairement, pour chaque route, si elle est publique, si elle exige le token Bearer (JWTAuth), et si elle exige l'en-tête de contexte de groupe X-Band-ID. Signaler les routes protégées par AdminOnly.
  4. Payloads et réponses — pour chaque endpoint, un exemple de corps de requête et la réponse attendue. Les structures exactes se trouvent dans backend/api/service/ (CreateSongPayload, etc.).
  5. Codes d'erreur — documenter le format d'erreur renvoyé par apierror et les codes existants.
  6. Mécanique d'invitation — expliquer le flux d'invitation par token, qui n'est pas évident à la lecture des seules routes.
  7. Lier depuis le README, dans la section Documentation existante.

Critères d'acceptation

  • Toutes les routes enregistrées dans main.go figurent dans le document
  • Chaque endpoint indique sa méthode, son chemin, ses en-têtes requis et son rôle minimum
  • Chaque endpoint de mutation a un exemple de payload JSON
  • Le format des erreurs est documenté
  • Le flux d'invitation est expliqué de bout en bout
  • Le README pointe vers docs/API.md

⚠️ Point de vigilance

Les payloads réels sont définis dans les services, pas dans les handlers. C'est backend/api/service/ qu'il faut lire pour connaître la forme exacte des JSON attendus.

Lenguaje dominante
Python
Estrellas
2
Forks
0
Merge medio
21 min
PR fusionados (30 d)
2

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 Doud75/Setly

Todos los issues de Doud75/Setly

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.