API仕様 - mune-actor-en/uchinoko-project GitHub Wiki
API仕様
API仕様につきましては、下記のスプレッドシートを参照ください。
仕様変更があった際も随時アップデートしていきます。
参照URL
編集履歴
- 2020/12/23 認証・認可の説明を追加しました
- 2020/12/19 Likesリソースの詳細仕様を追加しました
- 2020/12/17 Postsリソースの詳細仕様を追加しました
- 2020/12/12 Petsリソースの詳細仕様を追加しました
エンティティ作成の参考URL
※以降は非推奨です
目次
共通
ステータスコード
- 200 : OK
- 201 : Created リソース作成リクエストが成功した場合
- 400 : Bad Request パラメータに不備があった場合
- 401 : Unauthorized 認証に失敗した場合
- 403 : Forbidden アクセス権がない場合
- 404 : Not Found リソースが見つからない場合
- 500 : Internal Server Error サーバー側で予期せぬエラーが発生した場合
エラー発生時のレスポンス
- 作成中...
アクセス時のヘッダーについて
- 作成中...
認証
ログイン
概要
メールアドレス、パスワードで認証をリクエストします。
成功時、JWT(JsonWebToken)が返却されます。
リクエスト先
- メソッド : POST
- URL : /api/v1/auth
- 成功時のレスポンスコード : 200
リクエストパラメータ
- name : string
- password : string
- conformPassword : string
リクエストサンプル
{
"name": "名前ーー",
"password": "hoge1234",
"confirmPassword": "hoge1234"
}
レスポンスデータ
- message : string
- token : string
レスポンスサンプル
{
"message": "success",
"token": "rFQGjkgYJHD9Fpoy"
}
ログオフ
概要
ログオフします。
リクエスト先
- メソッド : DELETE
- URL : /api/v1/auth
- 成功時のレスポンスコード : 200(要確認
リクエストパラメータ
- なし
リクエストサンプル
- なし
レスポンスデータ
- id : number
レスポンスサンプル
{
"id": 1
}
Usersリソース
ユーザー情報の取得
概要
ユーザーの情報を取得します。
リクエスト先
- メソッド : GET
- URL : /api/v1/users/:id
- 成功時のレスポンスコード : 200
リクエストパラメータ
- なし
リクエストサンプル
- なし
レスポンスデータ
- id : number
- name : string
- email : string
レスポンスサンプル
{
"id": 1,
"name": "渋谷ののんべえ",
"email": "[email protected]"
}
サインアップ
概要
サインアップします。
リクエスト先
- メソッド : POST
- URL : /api/v1/users
- 成功時のレスポンスコード : 201
リクエストパラメータ
- name : string
- password : string
- confirmPassword: string
リクエストサンプル
{
"name": "名前一一",
"password": "hoge1234",
"confirmPassword": "hoge1234"
}
レスポンスデータ
- message : string
- token : string
レスポンスサンプル
{
"message": "success",
"token": "rFQGjkgYJHD9Fpoy"
}
ユーザー情報の編集
概要
ユーザー情報を編集します。
リクエスト先
- メソッド : PUT
- URL : /api/v1/users/:id
リクエストパラメータ
- id : number
- name : string
- password : string
リクエストサンプル
{
"id": 1,
"name": "名前一一",
"password": "hoge1234"
}
レスポンスデータ
- message : string
レスポンスサンプル
{
"message": "success"
}
ユーザーの削除
概要
ユーザー情報を削除します。
リクエスト先
- メソッド : POST
- URL : /api/v1/users/:id
- 成功時のレスポンスコード : 200
リクエストパラメータ
- id : number(要確認、URLにIDが含まれるため
リクエストサンプル
{
"id": 1
}
レスポンスデータ
- message : string
レスポンスサンプル
{
"message": "success"
}