yanmoai6666-star/go-simple-api

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

オープン

#3 opened on 2025/12/05

GitHub で見る
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Go (0 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (0 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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

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

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

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

コントリビューターガイド

調査方針
既存のREADMEを読み、各APIエンドポイントにリクエスト/レスポンスの例を追加してください。
技術スタック
go
領域
backend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85