Todo API

/todos

• GET: すべてのTodoを取得します。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。

• PUT: Todoを更新します。リクエストボディは必須で、更新するTodoの詳細を含むJSON形式である必要があります。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。バリデーションエラーが発生した場合は、422のHTTPステータスコードとともにエラーメッセージが返されます。

  • id: 必須項目。更新するTodoのIDを指定します。
  • title: オプション項目。Todoのタイトルを指定します。
  • description: オプション項目。Todoの説明を指定します。
  • due_date: オプション項目。Todoの締め切り日時を指定します。
  • status: オプション項目。Todoの状態を指定します。

• POST: 新しいTodoを作成します。リクエストボディは必須で、新しいTodoの詳細を含むJSON形式である必要があります。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。バリデーションエラーが発生した場合は、422のHTTPステータスコードとともにエラーメッセージが返されます。

  • title: オプション項目。Todoのタイトルを指定します。
  • description: オプション項目。Todoの説明を指定します。
  • due_date: オプション項目。Todoの締め切り日時を指定します。
  • status: オプション項目。Todoの状態を指定します。デフォルト値は "not_started" です。

リクエストボディの例

{
  "title": "新しいToDo",
  "description": "これは新しいToDoの内容です。",
  "due_date": "2024-03-07T12:00:00",
  "status": "not_started"
}

/todos/search

• GET: Todoを検索します。クエリパラメータ"q"は必須で、検索する文字列を指定します。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。バリデーションエラーが発生した場合は、422のHTTPステータスコードとともにエラーメッセージが返されます。

検索リクエスト例

GET /todos/search?q=新しい

/todos/{todo_id}

• GET: 特定のTodoを取得します。パスパラメータ"todo_id"は必須で、取得するTodoのIDを指定します。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。バリデーションエラーが発生した場合は、422のHTTPステータスコードとともにエラーメッセージが返されます。

• DELETE: 特定のTodoを削除します。パスパラメータ"todo_id"は必須で、削除するTodoのIDを指定します。成功すると、200のHTTPステータスコードとともにJSON形式のレスポンスが返されます。バリデーションエラーが発生した場合は、422のHTTPステータスコードとともにエラーメッセージが返されます。

リクエスト例

    GET /todos/1
    DELETE /todos/1