API docs by Redocly

openapi-todo-example (1.0.0)

Download OpenAPI specification:Download

URL: https://github.com/toms74209200/openapi-todo-example License: MIT

TODO application Web API example using by OpenAPI Specification

users

ユーザー登録API

ユーザーを登録する。

Request Body schema: application/json
email
required
string <email>

ユーザーのメールアドレス

password
required
string

ユーザーのパスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

auth

ユーザー認証API

ユーザー認証しトークンを取得する。

Request Body schema: application/json
email
required
string <email>

ユーザーのメールアドレス

password
required
string

ユーザーのパスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

tasks

タスク登録API

タスクを登録する。

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string

タスクの名前

description
required
string

タスクの説明

deadline
required
string <date-time>

タスクの期限。ISO 8601形式の日時文字列。

completed
boolean
Default: false

タスクが完了したかどうかを示す

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "deadline": "2019-08-24T14:15:22Z",
  • "completed": false
}

Response samples

Content type
application/json
{
  • "id": 0
}

ユーザーのタスク一覧取得API

指定したユーザーのタスク一覧を取得する。

Authorizations:
BearerAuth
query Parameters
userId
required
integer <int64>

取得するタスクのユーザーID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

タスク更新API

指定したタスクを更新する。

Authorizations:
BearerAuth
path Parameters
taskId
required
integer <int64>

更新するタスクのID

Request Body schema: application/json
name
string

タスクの名前

description
string

タスクの説明

deadline
string <date-time>

タスクの期限。ISO 8601形式の日時文字列。

completed
boolean
Default: false

タスクが完了したかどうかを示す

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "deadline": "2019-08-24T14:15:22Z",
  • "completed": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "deadline": "2019-08-24T14:15:22Z",
  • "completed": false
}

タスク削除API

指定したタスクを削除する。

Authorizations:
BearerAuth
path Parameters
taskId
required
integer <int64>

Responses