Documenter l'API REST du backend (docs/API.md)
还没有人认领这个 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 内容生成。
描述
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
- Créer
docs/API.md. Une spécification OpenAPI est également acceptable si le contributeur préfère. - Recenser les routes — analyser
backend/main.go, où toutes les routes sont enregistrées, et le dossierbackend/api/handler/. Couvrir/api/auth/*,/api/bands/*,/api/song/*,/api/setlist/*,/api/interlude/*. - 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 groupeX-Band-ID. Signaler les routes protégées parAdminOnly. - 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.). - Codes d'erreur — documenter le format d'erreur renvoyé par
apierroret les codes existants. - Mécanique d'invitation — expliquer le flux d'invitation par token, qui n'est pas évident à la lecture des seules routes.
- Lier depuis le README, dans la section Documentation existante.
Critères d'acceptation
- Toutes les routes enregistrées dans
main.gofigurent 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
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Doud75/Setly 的其他 Issue
-
agent-ready chore
难度 2/5 1-3 小时 新手友好度 86/100
-
backend enhancement frontend security
难度 4/5 3-5 天 新手友好度 48/100
-
agent-ready backend enhancement frontend security
难度 5/5 一周以上 新手友好度 25/100
-
agent-ready backend enhancement frontend security
难度 5/5 一周以上 新手友好度 35/100
-
agent-ready backend bug frontend security
难度 5/5 一周以上 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
marketcalls/openalgo#2472 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 95/100
marimo-team/marimo#11949 ·
维护者通常 1 天内回复
-
bug server-time v2
难度 2/5 1-3 小时 新手友好度 76/100
modelcontextprotocol/servers#5559 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
jxxghp/MoviePilot#7449 ·
维护者通常 1 天内回复
-
devops help wanted
难度 2/5 1-3 小时 新手友好度 72/100
guaardvark/guaardvark#421 ·
维护者通常 2 天内回复