メインコンテンツまでスキップ

エラー処理およびステータスコード

1. 一般的なエラーコードと処理

  • 400 Bad Request:
    リクエストが不正または無効なデータを含んでいる場合(例:必須フィールドの欠落)。

  • 401 Unauthorized:
    リクエストに有効なトークンがない場合やユーザーが認証されていない場合。

  • 403 Forbidden:
    ユーザーに必要な権限がない場合。

  • 404 Not Found:
    要求されたリソース(関数やジョブなど)が存在しない場合。

  • 500 Internal Server Error:
    サーバー側で問題が発生した場合(予期しないエラーなど)。

2. API レスポンスステータスコード

  • 200 OK:
    リクエストが正常に処理された場合。

  • 201 Created:
    リソース(関数やジョブなど)が正常に作成された場合。

  • 400 Bad Request:
    リクエストが無効または不正な場合。

  • 404 Not Found:
    要求されたリソースが見つからない場合。

  • 500 Internal Server Error:
    サーバー側でエラーが発生した場合。

3. エラーメッセージ使用ガイド

エラーメッセージは、ユーザーが何が問題かを理解できるように記述すべきです。例えば:

  • 無効な関数名:
    "関数名は必須で、3文字以上の文字列でなければなりません。"

  • 権限拒否:
    "この関数を削除する権限がありません。管理者に連絡してください。"