Skip to content

API Specification

hojun3377 edited this page Jul 18, 2024 · 2 revisions

API Specification

  1. 회원가입 및 로그인

    • POST /api/users/register
      • 설명: 새로운 사용자 계정 생성
      • 요청 바디: { "name": "string", "password": "string" }
      • 응답: {}
    • POST /api/users/login
      • 설명: 사용자 로그인
      • 요청 바디: { "username": "string", "password": "string" }
      • 응답: {}
  2. 메일 인증

    • POST /api/auth/email/verification
      • 설명: 서버에 인증 번호 생성
      • 요청 바디: { "email": "string" }
      • 응답: {}
    • PATCH /api/auth/email/verification
      • 설명: 쿠키의 토큰 확인 후 서버에 인증 번호 수정
      • 요청 바디: {}
      • 응답: {}
    • DELETE /api/auth/email/verification
      • 설명: 쿠키의 토큰 확인 후 서버에 인증 번호 삭제
      • 요청 바디: {}
      • 응답: {}
    • POST /api/auth/email/send-verification
      • 설명: 쿠키의 토큰 확인 후 인증번호 메일로 전송
      • 요청 바디: {}
      • 응답: {}
    • POST /api/auth/email/verify
      • 설명: 쿠키의 토큰 확인 후 인증 번호 검증
      • 요청 바디: { "code": "string" }
      • 응답: {}
Clone this wiki locally