yanmoai6666-star/go-simple-api

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

Open

#3 opened on Dec 5, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (0 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

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

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

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

Contributor guide

Research direction
Read the existing README and add request/response examples for each API endpoint.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85