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