api - nora75/SSA GitHub Wiki

APIの定義

ていうか自動生成されるんだけど草案ではい。 特筆しない限りGETになる。

  • 登録
    • POST
    • /Registeration
      • user_name
      • password
      • mail
      • group_id
        • 任意
        • 無い場合は、送信しない
    • 戻り
      • id
      • group_id
        • group_idが指定されていない場合に生成され返る
        • 指定してあるならば、オウム返し
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 The user already exists
      • 400 Invalid Request
  • ログイン
    • POST
    • /Login
      • mail
      • password
    • 戻り
      • boolean
        • 成功時のみtrueが返ります
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request
  • グループの変更
    • POST
    • /users/{id}
      • password
      • group_id
    • 戻り
      • boolean
        • 成功時のみtrueが返ります
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request
  • ユーザーの削除
    • DELETE
    • /users/{id}
      • password
    • 戻り
      • boolean
        • 成功時のみtrueが返ります
    • リスポンス
      • 202 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request
  • データのリストの取得
    • GET
    • /group/{group_id}
      • id
    • 戻り
      • データのリスト
        • data_type
        • data_name
        • title
        • date_time
        • user_name
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request
  • データの保存
    • POST
    • /group/{group_id}
      • id
      • data_name
      • data_type
      • Data
        • multipart/form-dataを使用してデータの送受信。
      • title
        • 任意
      • image_name
        • 任意
      • Image
        • multipart/form-dataを使用してデータの送受信。
        • 任意
        • 画像データ
    • 戻り
      • boolean
        • 成功時のみtrueが返ります
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request
  • データのピックアップ
    • GET
    • /group/{group_id}/{data_type}
      • id
      • data_name
    • 戻り
      • データ
      • title
        • 状況に応じて
      • image_name
        • 状況に応じて
      • Imageデータ
        • 状況に応じて
    • リスポンス
      • 200 StatusOK
      • 404 Invalid Group ID
      • 400 Invalid Request