docs: README "API Design" lists endpoints that do not exist

オープン
#54 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
express, javascript, node.js
領域
api, documentation

調査の方向性

Read the README's API Design section and compare it with the auth and course route files under routes/*.js, which define 33 routes. The suggested fix calls for an OpenAPI spec and CI checks, so first map the documented endpoints to the mounted routes and decide how the spec will be checked against them. Done means the README links an accurate spec and CI detects routes missing from either side.

索引モデルが issue の本文から書いたものです。

説明

documentation

The README's API Design section lists ten endpoints such as POST /api/auth/signup, POST /api/auth/verify-otp, GET /api/courses/:id and POST /api/courses/:id/rate. None of them exists in the code: the real routes are mounted under /api/v1/… and use action names, for example POST /api/v1/auth/signup, GET /api/v1/course/getAllCourses and POST /api/v1/course/getCourseDetails. The auth and course route files alone define 33 routes.

Suggested fix

  • Replace the list with an OpenAPI spec (openapi.yaml) generated from or checked against routes/*.js, and link a rendered version (Redocly or Swagger UI) from the README.
  • Add a CI step that fails when a route exists in the code but not in the spec, or the other way round.

Found while reviewing StudyNotion with Claude Code.

主要言語
JavaScript
スター
23
フォーク
8
平均マージ
11分
マージ済み PR(30日)
4

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

khemssharma/StudyNotion のほかの issue

khemssharma/StudyNotion の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。