Documenter l'API REST du backend (docs/API.md)
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR(30日)
- 2
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 25/100
-
agent-ready backend enhancement frontend security
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
agent-ready backend bug frontend security
難易度 5/5 1週間以上 初心者へのやさしさ 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 日以内に返信