API設計書

RESTful API・エンドポイント仕様・リクエスト/レスポンス形式を定義します

対象製品：Acsim Desktop

このページは2026年10月23日時点の内容です。ほかの設計書フォーマットは標準カタログの一覧で確認できます。

作成するエージェント

この設計書は、次のエージェントが作成します。

基盤・基本設計

保存先

「技術仕様書」の 01_基盤設計 フォルダに保存されます。ファイル名の先頭には、フォルダ内で読む順に並ぶよう 40_ が付きます。

構成

Acsim Desktop の設計書テンプレートの章立てと記載項目です。設計書はこの構成に沿って作成されます。

API設計書

1. 概要

1.1 目的

1.2 対象範囲

1.3 前提と制約

2. 共通仕様

ベースURL

{APIのベースURLを記載}

認証方式

共通ヘッダー

ヘッダー名	必須	説明
Authorization	○	認証トークン
Content-Type	○	application/json

共通エラーレスポンス

ステータスコード	説明
400	Bad Request - リクエストパラメータ不正
401	Unauthorized - 認証エラー
403	Forbidden - 権限エラー
404	Not Found - リソース未検出
422	Unprocessable Entity - バリデーションエラー
500	Internal Server Error - サーバーエラー

3. エンドポイント一覧

No	ドメイン	エンドポイント	メソッド	説明

4. エンドポイント定義

4.{連番} {エンドポイント名}

基本情報

項目	内容
エンドポイント	`{HTTPメソッド} /api/xxx`
認証	必要 / 不要
権限	{権限}

パスパラメータ

パラメータ名	型	必須	説明
{パラメータ名}	{型}	○	{説明}

クエリパラメータ

パラメータ名	型	必須	デフォルト	説明
{パラメータ名}	{型}	-	-	{説明}

リクエストボディ

フィールド名	型	必須	バリデーション	説明
{フィールド名}	{型}	○	{ルール}	{説明}

レスポンス（成功時）

ステータスコード: 200 OK

フィールド名	型	説明
{フィールド名}	{型}	{説明}

レスポンス（エラー時）

ステータスコード	条件	レスポンス例
422	バリデーションエラー	{説明}

5. 備考

データベース設計書

テーブル定義・ER図・インデックス・制約を含むデータベース設計を定義します

アーキテクチャ設計書

システム構成・レイヤー構成・モジュール分割・横断関心事の設計を定義します