API - boostcamp-2020/Project03-A-TOTP GitHub Wiki

API ๋ช…์„ธ

๋ชฉ์ฐจ

๊ธฐ๋ณธ API

  • prefix : /api

๋กœ๊ทธ์ธ์„ ์ œ์™ธํ•œ ๋ชจ๋“  ์ธ์ฆ์— session ์ •๋ณด ํ•„์š”

WEB

  • prefix : /web

ํšŒ์›๊ฐ€์ž…

  • prefix : /user

URL Method Description
/ post ํšŒ์›๊ฐ€์ž…
/dup-email post email ์ค‘๋ณตํ™•์ธ
/find-id post ID ์ฐพ๊ธฐ
/find-pw post PW ์ฐพ๊ธฐ
/secret-key get SecretKey ์š”์ฒญ
/secret-key put SecretKey ์žฌ๋ฐœ๊ธ‰ ์š”์ฒญ
/email get email ์ธ์ฆ ์š”์ฒญ URL ๋ฐœ์†ก
/confirm-email get email ์ธ์ฆ ์š”์ฒญ URL ํ™•์ธ
  • /

    ์ƒ์„ธ ์ •๋ณด
    • req
    {
        "name": "name",
        "email": "email",
        "birth": "birth",
        "phone": "phone",
        "id": "id",
        "password": "password"
    }
    • res
    {
        "result": true,
        "QRCode": "QRCode base32 Data" OR "SecretKey"
    }
  • /check

    ์ƒ์„ธ ์ •๋ณด
    • req
    {
        "id": "id" OR "email": "email"
    }
    • res
    {
        "result": true(์ค‘๋ณต๋˜๋Š” ๊ฐ’์ด ์—†๋‹ค๋ฉด) OR false(์ค‘๋ณต๋˜๋Š” ๊ฐ’์ด ์žˆ๋‹ค๋ฉด)
    }
  • /confirm-email

    ์ƒ์„ธ ์ •๋ณด
    • req
      • ์ด๋ฉ”์ผ ํŒŒ๋ผ๋ฏธํ„ฐ ์ „๋‹ฌ ํ•„์š”
    • res
    {
      "result": true(์„ฑ๊ณต์‹œ) OR false(๋งŒ๋ฃŒ์‹œ 400 error)
    }

๋กœ๊ทธ์ธ

  • prefix :/auth

URL Method Description
/ post ๋กœ๊ทธ์ธ
/dup-id post id ์ค‘๋ณตํ™•์ธ

๋‚ด์ •๋ณด

  • prefix : /info

URL Method Description
/ get ๊ฐœ์ธ์ •๋ณด ๋ฆฌ์ŠคํŠธ ์กฐํšŒ
/ patch ๊ฐœ์ธ์ •๋ณด ์ˆ˜์ •
/logs get ๋กœ๊ทธ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ
/session delete ์ ‘์† ๋ฌด๋ ฅํ™”

iOS

โš ๏ธ **GitHub.com Fallback** โš ๏ธ