diff --git a/userAPI.yaml b/userAPI.yaml index 2e17790..aeeb21f 100644 --- a/userAPI.yaml +++ b/userAPI.yaml @@ -1,8 +1,9 @@ swagger: "2.0" info: - description: "これはユーザ情報に関するAPIです。" + description: "これはCosmosのuserAPIです。" version: "1.0.0" - title: "user API" + title: "User API" + termsOfService: "http://swagger.io/terms/" host: "nitta-lab-www.is.konan-u.ac.jp" basePath: "/cosmos" schemes: @@ -16,7 +17,7 @@ consumes: - "multipart/form-data" parameters: - - name: "uid" + - name: "uId" in: "formData" description: "ユーザーID" required: true @@ -26,267 +27,169 @@ description: "ユーザーの名前" required: true type: "string" - - name: "pass" + - name: "pw" in: "formData" - description: "ユーザーのpass" + description: "ユーザーのパスワード" required: true type: "string" - name: "icon-image" in: "formData" description: "アイコンイメージ" - required: true + required: false type: "string" - # [$ref: "#/definitions/Parametars"] responses: 201: - description: "Userdate created" - + description: "成功時のレスポンス" + schema: + $ref: "#/definitions/User" - /users/createWithArray: - post: - summary: "Creates list of users with given input array" - description: "" - consumes: + + /users/{uId}: + get: + summary: "ユーザー情報を取得" + description: "userIdを指定してユーザーの情報を取得します。" + parameters: + - name: "uId" + in: "path" + description: "検索したいユーザーID" + required: true + type: "string" + responses: + 200: + description: "成功時のレスポンス" + schema: + type: "object" + properties: + name: + type: "string" + example: "甲南 太郎" + icon-image: + type: "string" + 400: + description: "無効なユーザー名が指定されました。" + 404: + description: "ユーザーが見つかりませんでした。" + put: + summary: "ユーザー情報を更新" + description: "ログインしているユーザのみが行えます。" + consumes: - "multipart/form-data" parameters: - - name: "uid" + - name: "uId" + in: "path" + description: "ユーザーIDの取得" + required: true + type: "string" + - name: "token" in: "formData" - description: "ユーザーID" + description: "トークンの更新" required: true type: "string" - name: "name" in: "formData" - description: "ユーザーの名前" - required: true + description: "ユーザー名の更新" + required: false type: "string" - - name: "pass" + - name: "pw" in: "formData" - description: "ユーザーのpass" - required: true + description: "パスワードの更新" + required: false type: "string" - name: "icon-image" in: "formData" - description: "アイコンイメージ" + description: "アイコンイメージの更新" + required: false + type: "string" + responses: + 200: + description: "更新しました" + + delete: + summary: "ユーザー情報を削除" + description: "userIdを指定してユーザーの情報を削除します。" + consumes: + - "multipart/form-data" + parameters: + - name: "uId" + in: "path" + description: "削除したいユーザーのユーザーID" required: true type: "string" - # [$ref: "#/definitions/Parametars"] + - name: "token" + in: "formData" + description: "削除したいユーザーのトークン" + required: true + type: "string" responses: - default: - description: "処理が成功しました。" + 200: + description: "削除しました" + 400: + description: "無効なユーザが指定されました。" + 404: + description: "ユーザが見つかりませんでした。" - /users/login: + /users/{uId}/login: get: - summary: "Logs user into the system." + summary: "ログイン" description: "" parameters: - - name: "userId" - in: "query" - description: "ログインのためのユーザ名" + - name: "uId" + in: "path" + description: "ログインのためのユーザーID" required: true type: "string" - - name: "password" + - name: "pw" in: "query" description: "ログインのためのパスワード" required: true type: "string" responses: 200: - description: "処理に成功" + description: "ログインしました" + schema: + $ref: "#/definitions/Token" 400: - description: "ユーザ名もしくはパスワードが間違っています。" + description: "ユーザIDもしくはパスワードが間違っています。" - /users/logout: + /users/{uId}/logout: get: - summary: "Logs out current logged in user session." + summary: "ログアウト" description: "" - parameters: [] - responses: - default: - description: "ログアウトしました。" - - /users/{userId}: - get: - summary: "ユーザー情報を取得" - description: "userIdを指定してユーザーの情報を取得します。" - parameters: - - name: "userId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "succesful operation." - schema: - $ref: "#/definitions/User" - 400: - description: "無効なユーザー名が指定されました。" - 404: - description: "ユーザーが見つかりませんでした。" - # put: - # summary: "Updated user." - # description: "ログインしているユーザのみが行えます。" - # consumes: - # - "multipart/form-data" - # parameters: - # - name: "userId" - # in: "path" - # description: "ユーザ名の更新" - # required: true - # type: "string" - # - name: "newName" - # in: "formData" - # description: "ユーザーの名前" - # required: true - # type: "string" - # responses: - # 400: - # description: "無効なユーザが指定されました。" - # 404: - # description: "ユーザが見つかりませんでした。" - delete: - summary: "ユーザー情報を削除" - description: "userIdを指定してユーザーの情報を削除します。" - parameters: - - name: "userId" - in: "path" - description: "削除したいユーザーのuserId" - required: true - type: "string" - responses: - 400: - description: "無効なユーザが指定されました。" - 404: - description: "ユーザが見つかりませんでした。" - - /users/{userId}/uId: - get: - summary: "uIdの取得" - description: "userIdで指定したユーザーのuIdを取得します。" - parameters: - - name: "userId" - in: "path" - required: true - type: "integer" - format: "int64" - responses: - default: - description: "取得に成功しました。" - schema: - type: "object" - properties: - uId: - type: "integer" - format: "int64" - put: - summary: "uIdの更新" - description: "userIdで指定したユーザーのuIdを更新します。" consumes: - "multipart/form-data" parameters: - - name: "userId" + - name: "uId" in: "path" + description: "ログアウトのためのユーザーID" required: true type: "string" - - name: "newName" + - name: "token" in: "formData" - description: "ユーザーの名前" + description: "ログアウトのためのトークン" required: true type: "string" responses: - default: - description: "uIdを更新しました。" - schema: - type: "object" - properties: - uId: - type: "integer" - format: "int64" - example: "123" + 200: + description: "ログアウトしました" + 404: + description: "ログアウトに失敗しました" - /users/{userId}/name: - get: - summary: "nameの取得" - description: "userIdで指定したユーザーのnameを取得します。" - parameters: - - name: "userId" - in: "path" - required: true - type: "string" - responses: - default: - description: "取得に成功しました。" - schema: - type: "object" - properties: - name: - type: "string" - put: - summary: "nameの更新" - description: "userIdで指定したユーザーのnameを更新します。" - parameters: - - name: "userId" - in: "path" - required: true - type: "string" - responses: - default: - description: "nameを更新しました。" - schema: - type: "object" - properties: - name: - type: "string" - example: "123" - - /users/{userId}/pass: - put: - summary: "passの更新" - description: "userIdで指定したユーザーのpassを更新します。" - parameters: - - name: "userId" - in: "path" - required: true - type: "string" - responses: - default: - description: "passを更新しました。" - schema: - type: "object" - properties: - name: - type: "string" - example: "123" definitions: - # Parametars: - # - name: "uid" - # in: "formData" - # description: "ユーザーID" - # required: true. - # type: "string" - # - name: "name" - # in: "formData" - # description: "ユーザーの名前" - # required: true - # type: "string" - # - name: "pass" - # in: "formData" - # description: "ユーザーのpass" - # required: true - # type: "string" - # - name: "icon-image" - # in: "formData" - # description: "アイコンイメージ" - # required: true - # type: "string" User: type: "object" properties: uId: - type: "integer" - format: "int64" + type: "string" + example: "12345@6789.com" name: type: "string" - pass: + example: "甲南 太郎" + uri: type: "string" - icon-image: + example: "http://12345.com" + + Token: + type: "object" + properties: + token: type: "string" \ No newline at end of file