PythonBulawayo/ChitChat

Add API Endpoint Documentation

開放

#23 建立於 2024年1月25日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人)TypeScript (24 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (25 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

The API is currently undocumented. Add documentation to make it easy to build against the API. We should consider using a tool like Swagger to document our endpoints.

貢獻者指南

研究方向
探索程式碼庫以識別所有 API 端點，然後選擇像 Swagger 這樣的文件工具來記錄每個端點的方法、參數和回應範例。
技術棧
typescript
領域
apidocumentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75