yanmoai6666-star/go-simple-api

完善 API 文档，补充请求/响应示例

Offen

#3 geöffnet am 05.12.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (0 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (0 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

README 中已列出 API 端点，但缺少具体的请求体格式、响应示例和状态码说明。例如：

  • POST /api/v1/products 需要哪些字段？price 字段的格式要求是什么？
  • 接口成功/失败时的响应结构（如错误信息格式）不明确

建议补充每个接口的详细说明，包括：

  • 请求头、请求体示例（JSON 格式）
  • 成功响应示例（含状态码 200/201）
  • 错误响应示例（如 400 无效输入、500 服务器错误）
  • 字段说明（如 UserID 与用户的关联关系）

Contributor Guide

Research-Richtung
Lesen Sie die vorhandene README und fügen Sie für jeden API Endpunkt Beispiele für Anfrage/Antwort hinzu.
Tech Stack
go
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85