Skip to content
LeeSangHoon edited this page Apr 24, 2023 · 21 revisions

📜 API 목록

API Description
POST /api/auth/signup 회원가입
POST /api/auth/login 로그인
POST /api/auth/logout 로그아웃
POST /api/auth/verify 로그인 토큰 검증
API Description
GET /api/user/:userId 사용자 상세 조회
PUT /api/user/:userId/profile 사용자 프로필 변경
GET /api/user/:userId/trade-history 사용자의 교환 내역 조회
GET /api/user/:userId/shipping-address 사용자의 배송 주소 목록 조회
POST /api/user/:userId/shipping-address 사용자의 배송 주소 등록
API Description
GET /api/group 그룹 목록 조회
POST /api/group 그룹 등록
GET /api/group/:groupId 그룹 상세 조회
PUT /api/group/:groupId 그룹 수정
DELETE /api/group/:groupId 그룹 삭제
POST /api/group/:groupId/member 멤버 추가
API Description
GET /api/member 멤버 목록 조회
GET /api/member/:memberId 멤버 상세 조회
PUT /api/member/:memberId 멤버 수정
DELETE /api/member/:memberId 멤버 삭제
API Description
GET /api/photo 포토카드 목록 조회
POST /api/photo 포토카드 등록
GET /api/photo/:photocardId 포토카드 상세 조회
PUT /api/photo/:photocardId 포토카드 수정
DELETE /api/photo/:photocardId 포토카드 삭제
API Description
GET /api/voucher 소유권 목록 조회
POST /api/voucher 소유권 발급
GET /api/voucher/:voucherId 소유권 상세 조회
DELETE /api/voucher/:voucherId 소유권 삭제
GET /api/voucher/:voucherId/log 소유권 기록 조회
GET /api/voucher/:voucherId/trade 소유권으로 등록한 교환글 조회
API Description
GET /api/trade 교환글 목록 조회
POST /api/trade 교환글 등록
GET /api/trade/:tradeId 교환글 상세 조회
PUT /api/trade/:tradeId 교환글 수정
DELETE /api/trade/:tradeId 교환글 삭제
GET /api/trade/:tradeId/exchange 교환 가능한 소유권 조회
POST /api/trade/:tradeId/exchange 교환
API Description
PUT /api/shipping/address/:addressId 배송지 수정
DELETE /api/shipping/address/:addressId 배송지 삭제
PATCH /api/shipping/address/:addressId/prime 기본 배송지 변경
GET /api/shipping/request 배송 요청 목록 조회
POST /api/shipping/request 배송 요청 등록
GET /api/shipping/request/:requestId 배송 요청 상세 조회
DELETE /api/shipping/request/:requestId 배송 요청 삭제
POST /api/shipping/request/:requestId/payment 결제 검증
POST /api/shipping/request/:requestId/refund 결제 환불
POST /api/shipping/request/:requestId/approve 발송 완료 처리

공통 응답

유효성 검사 실패

Response

{
    "_status": 409,
    "message": "올바른 정보를 입력해주세요!"
    "errors": [{
        "message": "${유효성 검사 부분에서 반환한 메시지}",
        "param": "${오류가 발생한 데이터 필드 명}"
    }]
}

응답 예시

{
    "_status": 409,
    "message": "올바른 정보를 입력해주세요!",
    "errors": [
        {
            "message": "아이디가 비어있어요.",
            "param": "username"
        },
        {
            "message": "비밀번호가 비어있어요.",
            "param": "password"
        }
    ]
}

권한 실패

Response

{
    "_status": 403,
    "message": "해당 기능을 사용할 권한이 없어요."
}
Clone this wiki locally