Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[PROPOSAL] Add versioned REST API endpoints for test results for NG frontend

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

メンテナーはふだん 6 日以内に返信

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
api, backend

調査の方向性

まず既存のモデルとコントローラーのロジックを確認し、提案されている mod_api blueprint がアプリケーションにどのように適合するかを判断します。テスト結果とカテゴリのバージョン付きエンドポイントを、整合性のある JSON レスポンスとテストが存在しない場合の処理とともに追加します。成功時と未検出時の統合テストを tests/test_api/ 配下に追加し、nose2 テストスイートを実行します。

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

説明

[PROPOSAL] Add versioned REST API endpoints for test results to support Sample Platform NG frontend

Problem

The current platform primarily serves HTML pages and has very limited API surface. The NG frontend direction needs stable, versioned JSON endpoints for test summary/results/files/progress and category metadata.

Proposed endpoints
  • GET /api/v1/tests/<id>/summary
  • GET /api/v1/tests/<id>/results
  • GET /api/v1/tests/<id>/files
  • GET /api/v1/tests/<id>/progress
  • GET /api/v1/categories
Proposed implementation notes
  • Introduce a dedicated mod_api blueprint.
  • Reuse existing model/controller logic where possible to avoid behavior drift.
  • Return structured JSON with consistent status envelope and 404 handling for missing tests.
  • Add focused API tests for success and not-found paths.
Why this is valuable
  • Unblocks frontend/API decoupling for NG work.
  • Creates a clear contract for external consumers and automation.
  • Reduces coupling to server-rendered templates.
Verification plan
  • Add integration tests under tests/test_api/.
  • Validate endpoint behavior locally with nose2 test suite.

In raising this issue, I confirm the following (please check boxes, eg [X]):

  • I have read and understood the contributors guide.
  • I have checked that the bug-fix I am reporting can be replicated, or that the feature I am suggesting isn't already present.
  • I have checked that the issue I'm posting isn't already reported.
  • I have checked that the issue I'm posting isn't already solved and no duplicates exist in closed issues and in opened issues
  • I have checked the pull requests tab for existing solutions/implementations to my issue/suggestion.

My familiarity with the project is as follows (check one, eg [X]):

  • I have never visited/used the platform.
  • I have used the platform just a couple of times.
  • I have used the platform extensively, but have not contributed previously.
  • I am an active contributor to the platform.

主要言語
Python
スター
30
フォーク
87
平均マージ
4日 9時間
マージ済み PR(30日)
13

環境構築

はじめの一歩

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

CCExtractor/sample-platform のほかの issue

CCExtractor/sample-platform の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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