yanmoai6666-star/go-simple-api

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

Aperta

#3 aperta il 5 dic 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Go (0 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (0 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

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

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

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

Guida contributor

Direzione di ricerca
Leggi il README esistente e aggiungi esempi di richiesta/risposta per ogni endpoint API.
Tech stack
go
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85