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

未关闭
#92 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
58/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
冷清
技术栈
go, openapi
领域
api, documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
2
派生
0
平均合并
21 分钟
30 天内合并 PR
2

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Doud75/Setly 的其他 Issue

查看 Doud75/Setly 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。