API定義書を作成する

最終更新日時

Feb 20, 2024 7:58 AM

ツール

ChatGPT

利用シーン

設計/API設計

事前プロンプト例

設計情報をもとに、API一覧を整理します。
step by stepで考え、その結果のみ表形式で出力してください。

API名、説明、REST種別、エンドポイント、API-ID、利用するTBL

### 設計仕様
勤怠管理システム

アウトプット例

以下は勤怠管理システムのAPI一覧です：
API名
説明
REST種別
エンドポイント
API-ID
利用するTBL
出勤登録API
従業員の出勤を登録します
POST
/api/attendance/in
001
従業員情報テーブル
退勤登録API
従業員の退勤を登録します
POST
/api/attendance/out
002
従業員情報テーブル
勤怠照会API
勤怠情報を照会します
GET
/api/attendance/query
003
勤怠情報テーブル
以上が、勤怠管理システムのAPI一覧です。それぞれのAPIの詳細情報と、REST種別、エンドポイント、API-ID、利用するTBLが示されています。

質問例

API-ID 001 出勤登録APIのAPI定義書を作成してください。

アウトプット例

出勤登録API（API-ID: 001）のAPI定義書は以下の通りです。
API名
出勤登録API
説明
このAPIは従業員の出勤情報を登録するために使用されます。従業員が勤務を開始した際に呼び出され、該当する従業員の出勤情報をシステムに記録します。
REST種別
POST
エンドポイント
/api/attendance/in
リクエスト
リクエストヘッダー
Content-Type: application/json
リクエストボディ
以下のJSON形式のデータをリクエストボディに含めてください。
{
  "employee_id": "従業員のID",
  "timestamp": "出勤時刻 (ISO 8601形式)",
  "location": "出勤場所"
}
レスポンス
レスポンスヘッダー
Content-Type: application/json
レスポンスボディ
成功時のレスポンスは以下のJSON形式です。
{
  "message": "出勤情報が正常に登録されました。",
  "attendance_id": "新しく生成された出勤情報のID"
}
エラーレスポンス
エラーが発生した場合、適切なHTTPステータスコードとエラーメッセージが返されます。例えば、不正なリクエストデータが提供された場合、HTTP 400 Bad Requestとエラーメッセージが返されます。
利用するTBL
従業員情報テーブル
これが出勤登録API（API-ID: 001）のAPI定義書です。このAPIを使用することで、従業員の出勤情報をシステムに正確に登録することができます。

chat.openai.com

設計情報をもとに、API一覧を整理します。 step by stepで考え、その結果のみ表形式で出力してください。 API名、説明、REST種別、エンドポイント、API-ID、利用するTBL ### 設計仕様勤怠管理システム

アウトプット例

以下は勤怠管理システムのAPI一覧です：

API名	説明	REST種別	エンドポイント	API-ID	利用するTBL
出勤登録API	従業員の出勤を登録します	POST	/api/attendance/in	001	従業員情報テーブル
退勤登録API	従業員の退勤を登録します	POST	/api/attendance/out	002	従業員情報テーブル
勤怠照会API	勤怠情報を照会します	GET	/api/attendance/query	003	勤怠情報テーブル

以上が、勤怠管理システムのAPI一覧です。それぞれのAPIの詳細情報と、REST種別、エンドポイント、API-ID、利用するTBLが示されています。

アウトプット例

出勤登録API（API-ID: 001）のAPI定義書は以下の通りです。

API名

出勤登録API

説明

このAPIは従業員の出勤情報を登録するために使用されます。従業員が勤務を開始した際に呼び出され、該当する従業員の出勤情報をシステムに記録します。

REST種別

POST

エンドポイント

/api/attendance/in

リクエスト

リクエストヘッダー

Content-Type: application/json

リクエストボディ

以下のJSON形式のデータをリクエストボディに含めてください。

{
  "employee_id": "従業員のID",
  "timestamp": "出勤時刻 (ISO 8601形式)",
  "location": "出勤場所"
}

レスポンス

レスポンスヘッダー

Content-Type: application/json

レスポンスボディ

成功時のレスポンスは以下のJSON形式です。

{
  "message": "出勤情報が正常に登録されました。",
  "attendance_id": "新しく生成された出勤情報のID"
}

エラーレスポンス

エラーが発生した場合、適切なHTTPステータスコードとエラーメッセージが返されます。例えば、不正なリクエストデータが提供された場合、HTTP 400 Bad Requestとエラーメッセージが返されます。

利用するTBL

従業員情報テーブル

これが出勤登録API（API-ID: 001）のAPI定義書です。このAPIを使用することで、従業員の出勤情報をシステムに正確に登録することができます。