スロット攻略 プロジェクトドキュメント

Appearance

バックエンド設計書フォーマットガイド ​

REST API（API-001-*）などバックエンド契約の設計書の粒度と記載ルールを定義する。フロント向けの画面設計は 画面設計書フォーマットガイド.md（PUB-/ADM-）を参照。

前提 ​

  • バックエンドとフロントは IF-*（Presentation DTO） を境界として中継する（詳細はリポジトリ直下 .cursor/rules/design-doc-guidelines.mdc）。
  • リクエスト・レスポンスはテーブル形式で記載する（箇条書き・文章のみにしない）。
  • API-001-* 設計書にワイヤーフレームセクションは置かない（描画は PUB-* 側）。
  • 未記載・別タスクで埋める内容はセクションに TODO: を書く（空白のままにしない）。

API-001-*（個別 REST エンドポイント）ひな形 ​

1 エンドポイントにつき 1 ファイル。名前は API-{グループ}-{連番}_{論理名}.md。レジストリは API-一覧。

md
# API-001-1 ランキング非同期取得

[← API-一覧](../一覧/API-一覧.md)

## 概要

TODO: エンドポイントの役割を一文で記載する

## 入力（リクエスト）

| param | 必須 | 型・制約 | 説明 |
| ----- | ---- | -------- | ---- |
| TODO  |      |          |      |

## 出力（レスポンス）

### 成功時 data

| field | 型  | 説明 |
| ----- | --- | ---- |
| TODO  |     |      |

### 失敗・エラー条件

| 条件 | レスポンス形式 |
| ---- | -------------- |
| TODO |                |

## 権限・nonce

名前空間共通事項は [API-一覧](../一覧/API-一覧.md) を参照し、本エンドポイント固有の差分のみ記載する。

TODO: 差分がなければ「共通のみ」と明記する

同期・非同期の整理 ​

  • 初回 HTML と非同期補完の切り分けは PUB-* のブロック一覧「初回表示のされ方」 で管理する。
  • 同期・非同期で描画が同じなら ワイヤーフレームは同一 React コンポーネントを参照する（SC-/PUB- に集約）。
  • 同期・非同期で返すデータ契約が同一なら API 設計書は 1 ファイルにまとめてよい。

関連 ​