Skip to content

API 문서

chasw0326 edited this page Jun 16, 2022 · 21 revisions
  • 테스트용 아이디
   "email": "choi@ssg.com",
   "password": "ssgSSG123!@#"

테스트용 더미데이터 commandLineRunner로 생성해놓아서 로그인 이후 받은 토큰을 Authorization에 bearer token으로 담아서 테스트 가능합니다.

Index

  1. API 공통 사항
대분류 기능 method URI
User 회원가입 POST /api/user
로그인 POST /auth/signin
사용자의 정보 조회 GET /api/user
회원 탈퇴 PUT /api/user/withdrawal
정보 수정 PUT /api/user
비밀번호 변경 PUT /api/user/password
Product 단일 상품조회 GET /api/product/{productId}
일반회원용 상품조회 GET /api/product/normal
기업회원용 상품조회 GET /api/product/enterprise
본인이 등록한 상품조회 GET /api/product
상품 등록 POST /api/product
상품 수정 PUT /api/product/{productId}
상품 삭제 DELETE /api/product/{productId}
Promotion 본인이 등록한 프로모션 조회 GET /api/promotion
프로모션 등록 POST /api/promotion
프로모션 적용 POST /api/promotion/{promotionId}
상품에 적용된 프로모션 삭제 DELETE /api/promotion/{promotionId}/product/{productId}
프로모션 자체를 삭제 DELETE /api/promotion/{promotionId}

0. API 공통 사항

페이징 처리

  • 페이징 옵션이 필요한 경우 page, size를 추가 Query paramter로 전달한다.

Request 예시

  • /api/product?page=2&size=2

페이징 처리가 되어 있는 API

1. User

1-1. 회원가입

  • 회원가입

URL

  • POST /api/user

Request

param type required description
email body true 이메일
password body true 비밀번호(영소문자, 대문자, 특수문자, 숫자 포함 8~20글자)
name body true 이름
userType body true 유저타입 (일반회원,기업회원)

Request 예시

{
    "email": "testing@ssg.com",
    "password": "abcABC123!@#",
    "name": "홍길동",
    "userType" : "일반회원"
}

Response 예시

  • 성공(200)

  • 실패

    • 중복된 이메일(409)
{
   "message": "Email already exists input:{email}"
}
  • 실패
    • 비밀번호 강도 미충족(400)
{
   "message": "비밀번호 형식을 확인하세요. (8~20자, 대문자, 소문자, 특수문자, 숫자 포함)"
}

1-2. 로그인

  • 사용자의 정보로 로그인한다.

URL

  • POST /auth/signin

Request

param type required description
email body true 이메일
password body true 비밀번호(영소문자, 대문자, 특수문자, 숫자 포함 8~20글자)

Request 예시

{
    "email" : "cha@ssg.com" ,
    "password" : "ssgSSG123!@#"
}

Response 예시

eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDg1NDA3NjYsImV4cCI6MTY1MTEzMjc2Niwic3ViIjoiMzI5QG5hdmVyLmNvbSJ9.nN_yyOcOwLncc-OHPMRBXdngtTHaOdEJulG5_HHKRq0
  • localStorage에 담아서 다음 요청보터 Authorization에 Bearer Token으로 보내주세요.
const accessToken = localStorage.getItem("ACCESS_TOKEN");
  if (accessToken && accessToken !== null) {
    headers.append("Authorization", "Bearer " + accessToken);
  }
  • 실패(403)
   "message" : "아이디나 비밀번호를 확인하세요."

1-3. 내 정보 조회

  • 내 정보를 조회한다.

URL

  • GET /api/user

Request

  • None

Response

  • 성공(200)
{
    "createdAt": "2022-06-12T17:19:45.223567",
    "updatedAt": "2022-06-12T17:19:45.223567",
    "id": 1,
    "email": "cha@ssg.com",
    "name": "차선욱",
    "userType": [
        "일반회원"
    ],
    "userState": "정상"
}

1-4. 회원 탈퇴

  • 회원을 탈퇴상태로 만듭니다.

URL

  • PUT /api/user/withdrawal

Request

  • None

Response

  • 성공(200)

1-5. 정보 수정

  • 사용자의 이름을 수정합니다.

URL

  • PUT /api/user

Request

param type required description
name body true 이름

Request 예시

{
    "name" : "개명"
}

Response

  • 성공(200)

1-6. 비밀번호 변경

  • 사용자의 비밀번호를 변경합니다.

URL

  • PUT /api/user/password

Request

param type required description
oldPw body true 현재 비밀번호
newPw body true 새로운 비밀번호
checkPw body true 확인 비밀번호

Request 예시

{
    "oldPw" : "ssgSSG123!@#",
    "newPw" : "abcABC123!@#",
    "checkPw" : "abcABC123!@#"
}

Response

  • 성공(200)
  • 실패
    • 비밀번호 강도가 약할 때(409)
{
    "message": {
        "exception": "MethodArgumentNotValidException",
        "errors": {
            "newPw": "비밀번호는 영문 대,소문자와 숫자, 특수기호가 적어도 1개 이상씩 포함된 8자 ~ 20자의 비밀번호여야 합니다."
        }
    }
}
  • 실패
    • 확인 비밀번호가 새 비밀번호와 다를 때(400)
{
    "message": "확인 비밀번호가 새 비밀번호와 다릅니다."
}

2. Product

2-1. 단일 상품조회

  • 하나의 상품을 조회합니다.

URL

  • GET /api/product/{productId}

Request

  • None

Response

  • 성공(200)
{
    "name": "샤넬",
    "description": "핸드백3",
    "fullPrice": 2000000,
    "discountedPrice": 1400000,
    "startedAt": "2022-06-10T00:00:00",
    "endAt": "2022-06-30T23:59:59",
    "username": "이수경"
}
  • 실패
    • 일반회원이 기업회원용 상품을 조회할 때(403)
{
    "message": "권한이 없습니다."
}
  • 실패
    • 탈퇴한 회원이 조회할 때(403)
{
    "message": "권한이 없습니다."
}

2-2. 일반회원용 상품조회

  • 일반회원용 상품들을 조회합니다.

URL

  • GET /api/product/normal

Request

  • None

Response

  • 성공(200)
[
    {
        "id": 17,
        "name": "맥북프로",
        "description": "M1Pro 16Inch",
        "fullPrice": 4000000,
        "discountedPrice": 2400000,
        "createdAt": "2022-06-12T18:54:55.00431",
        "startAt": "2022-01-01T00:00:00",
        "endAt": "2022-12-31T23:59:59",
        "promotionId": 11,
        "promotionName": "프로모션11",
        "policy": "FIXED",
        "userId": 5,
        "username": "김구현",
        "userType": "일반회원"
    },
    {
        "id": 8,
        "name": "프라다",
        "description": "반지4",
        "fullPrice": 4000000,
        "discountedPrice": 2800000,
        "createdAt": "2022-06-12T18:54:54.945555",
        "startAt": "2022-01-01T00:00:00",
        "endAt": "2022-12-31T23:59:59",
        "promotionId": 6,
        "promotionName": "프로모션6",
        "policy": "FIXED",
        "userId": 1,
        "username": "차선욱",
        "userType": "일반회원"
    },
    {
        "id": 7,
        "name": "생로랑",
        "description": "반지3",
        "fullPrice": 2500000,
        "discountedPrice": 1750000,
        "createdAt": "2022-06-12T18:54:54.938574",
        "startAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": 6,
        "promotionName": "프로모션6",
        "policy": "FIXED",
        "userId": 1,
        "username": "차선욱",
        "userType": "일반회원"
    },
    {
        "id": 6,
        "name": "불가리",
        "description": "반지2",
        "fullPrice": 1400000,
        "discountedPrice": 800000,
        "createdAt": "2022-06-12T18:54:54.932596",
        "startAt": "2022-06-01T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": 7,
        "promotionName": "프로모션7",
        "policy": "FLAT",
        "userId": 1,
        "username": "차선욱",
        "userType": "일반회원"
    }
]
  • 실패
    • 탈퇴한 회원이 조회할 때(403)
{
    "message": "권한이 없습니다."
}

2-3. 기업회원용 상품조회

  • 기업회원용 상품들을 조회합니다.

URL

  • GET /api/product/enterprise

Request

  • None

Response

  • 성공(200)
[
    {
        "id": 19,
        "name": "까르띠에",
        "description": "시계5",
        "fullPrice": 150000000,
        "discountedPrice": 150000000,
        "createdAt": "2022-06-12T19:12:26.331247",
        "startAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": null,
        "promotionName": null,
        "policy": null,
        "userId": 3,
        "username": "최상면",
        "userType": "기업회원"
    },
    {
        "id": 18,
        "name": "IWC",
        "description": "시계4",
        "fullPrice": 310000000,
        "discountedPrice": 310000000,
        "createdAt": "2022-06-12T19:12:26.325263",
        "startAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": null,
        "promotionName": null,
        "policy": null,
        "userId": 3,
        "username": "최상면",
        "userType": "기업회원"
    },
    {
        "id": 11,
        "name": "바쉐린콘스탄틴",
        "description": "시계3",
        "fullPrice": 30000000,
        "discountedPrice": 21000000,
        "createdAt": "2022-06-12T19:12:26.277888",
        "startAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": 3,
        "promotionName": "프로모션3",
        "policy": "FIXED",
        "userId": 3,
        "username": "최상면",
        "userType": "기업회원"
    }
]
  • 실패
    • 탈퇴한 회원이 조회할 때(403)
{
    "message": "권한이 없습니다."
}
  • 실패
    • 일반회원이 조회할 때(403)
{
    "message": "권한이 없습니다."
}

2-4. 내가 등록한 상품 조회

  • 본인이 등록한 상품들을 조회합니다.

URL

  • GET /api/product

Request

  • None

Response

  • 성공(200)
[
    {
        "productId": 9,
        "name": "파텍필립",
        "description": "시계1",
        "fullPrice": 200000000,
        "discountedPrice": 100000000,
        "startedAt": "2022-12-01T00:00:00",
        "endAt": "2022-12-25T23:59:59",
        "promotionId": 1,
        "promotionName": "프로모션1"
    },
    {
        "productId": 10,
        "name": "오메가",
        "description": "시계2",
        "fullPrice": 120000000,
        "discountedPrice": 119400000,
        "startedAt": "2022-06-01T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": 7,
        "promotionName": "프로모션7"
    },
    {
        "productId": 11,
        "name": "바쉐린콘스탄틴",
        "description": "시계3",
        "fullPrice": 30000000,
        "discountedPrice": 21000000,
        "startedAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": 3,
        "promotionName": "프로모션3"
    },
    {
        "productId": 12,
        "name": "롤렉스",
        "description": "시계4",
        "fullPrice": 40000000,
        "discountedPrice": 39960000,
        "startedAt": "2022-01-01T00:00:00",
        "endAt": "2022-12-31T23:59:59",
        "promotionId": 4,
        "promotionName": "프로모션4"
    },
    {
        "productId": 18,
        "name": "IWC",
        "description": "시계4",
        "fullPrice": 310000000,
        "discountedPrice": 310000000,
        "startedAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": null,
        "promotionName": null
    },
    {
        "productId": 19,
        "name": "까르띠에",
        "description": "시계5",
        "fullPrice": 150000000,
        "discountedPrice": 150000000,
        "startedAt": "2022-06-10T00:00:00",
        "endAt": "2022-06-30T23:59:59",
        "promotionId": null,
        "promotionName": null
    }
]

2-5. 상품 등록

  • 상품을 등록합니다.

URL

  • POST /api/product

Request

param type required description
name body true 상품명
description body true 설명
fullPrice body true 가격 (unsigned int)
authority body true 권한, (일반회원 or 기업회원)
start body true 시작 시점 (YYYY-MM-DD HH:MM:SS)
end body true 종료 시점 (YYYY-MM-DD HH:MM:SS)

Request 예시

{
    "name" : "상품명",
    "description" : "상품설명",
    "fullPrice" : 100000,
    "authority" : "일반회원",
    "start" : "2022-06-01 00:00:00",
    "end" : "2022-12-01 00:00:00"
}

Response

  • 성공(200)
  • 실패
    • 종료시점이 시작시점보다 빠를때(400)
{
    "message": "종료시점이 시작시점보다 빠릅니다."
}

2-6. 상품 수정

  • 상품정보를 수정합니다.
  • 가격을 수정할 경우 더 적합한 프로모션이 있는지 체크하고 있으면 변경, 없으면 그대로

URL

  • PUT /api/product/{productId}

Request

param type required description
name body false 상품명
description body false 설명
price body false 가격 (unsigned int)
authority body false 권한, (일반회원 or 기업회원)
start body false 시작 시점 (YYYY-MM-DD HH:MM:SS)
end body false 종료 시점 (YYYY-MM-DD HH:MM:SS)

Request 예시

{
    "name" : "상품명수정",
    "description" : "상품설명 수정",
    "fullPrice" : 100000
}
{
    "start" : "2022-06-01 00:00:00",
    "end" : "2022-12-01 00:00:00"
}
{
    "price" : 2000000
}

Response

  • 성공(200)
  • 실패
    • 수정한 종료시점이 시작시점보다 빠를 때(400)
{
    "message": "종료시점이 시작시점보다 빠릅니다."
}
  • 실패
    • 다른사람이 수정시도 할 때(403)
{
    "message": "수정 권한이 없습니다."
}

2-7. 상품 삭제

  • 상품을 삭제합니다.

URL

  • DELETE /api/product/{productId}

Request

  • None

Response

  • 성공(200)
  • 실패
    • 다른사람이 삭제시도 할 때(403)
{
    "message": "삭제 권한이 없습니다."
}

Promotion

3-1. 본인의 프로모션 조회

  • 본인이 등록한 프로모션을 조회합니다.

URL

  • GET /api/promotion

Request

  • None

Response

param description
productIds 프로모션이 적용된 상품id들
  • 성공(200)
[
    {
        "id": 5,
        "name": "프로모션5",
        "description": "여름할인",
        "policy": "FIXED",
        "discountRate": 20,
        "startedAt": "2022-06-01T00:00:00",
        "endAt": "2022-06-30T00:00:00",
        "productIds": [
            5,
            7,
            15,
            11
        ]
    },
    {
        "id": 6,
        "name": "프로모션6",
        "description": "여름할인",
        "policy": "FIXED",
        "discountRate": 30,
        "startedAt": "2022-06-01T00:00:00",
        "endAt": "2022-06-30T00:00:00",
        "productIds": [
            13,
            5,
            8,
            7
        ]
    }
]

3-2. 프로모션 등록

  • 프로모션을 등록합니다.

URL

  • POST /api/promotion

Request

param type required description
name body true 프로모션명
description body true 설명
policy body true FLAT(정액제), FIXED(정률제)
discountRate body true 할인율(int), (if 정률제 0 < discountRate < 100)
start body true 시작 시점 (YYYY-MM-DD HH:MM:SS)
end body true 종료 시점 (YYYY-MM-DD HH:MM:SS)

Request 예시

{
    "name" : "프로모션명",
    "description" : "여름할인",
    "policy" : "FLAT",
    "discountRate" : 30000,
    "start": "2022-06-01 00:00:00",
    "end": "2022-06-30 00:00:00"   
}

Response

  • 성공(200)
  • 실패
    • 정률제 할인율 범위 틀릴 때(400)
   "message" : "정률제의 할인율 범위는 1부터 99까지 가능합니다."
  • 실패
    • 정액제 할인율 범위 틀릴 때(400)
   "message" : "정액제의 할인율 범위는 0보다 커야 합니다."
  • 실패
    • 종료시점이 시작시점보다 빠를 때(400)
   "message" : "종료시점이 시작시점보다 빠릅니다."

3-3. 프로모션 적용

  • 프로모션을 상품에 적용합니다.
  • (상품, 프로모션)을 UK로 설정했지만 이미 있는 경우 다음 상품으로 넘어가기 때문에 제약조건 위배되는 상황x
  • 현재 시작중이거나 끝나지 않은 프로모션만 적용가능

URL

  • POST /api/promotion

Request

param type required description
productIds body true 프로모션을 적용할 상품pk들

Request 예시

{
     "productIds" : [1,2,3]
}

Response

  • 성공(200)
  • 실패
    • 프로모션 주인이 아닐 때(400)
   "message" : "권한이 없습니다."
  • 실패
    • 현재 시점이 시작 시점보다 앞일 때(400)
   "message" : "시작되지 않은 프로모션 입니다."
  • 실패
    • 현재 시점이 종료 시점보다 뒤일 때(400)
   "message" : "종료된 프로모션 입니다."
  • 실패
    • 존재하지 않는 상품 일 때(400)
   "message" : "can not find product by productId: {productId}"

3-4. 특정상품에 적용된 프로모션 삭제

  • 특정 상품에 적용된 프로모션을 삭제합니다. (프로모션 자체 삭제X)
  • 삭제한 뒤, 상품에 다음으로 할인율이 높은 프로모션을 적용합니다.

URL

  • DELETE /api/promotion/{promotionId}/product/{productId}

Request

  • None

Response

  • 성공(200)

  • 실패

    • 프로모션 주인이 아닐 때(400)
   "message" : "권한이 없습니다."

3-5. 프로모션 자체를 삭제

  • 프로모션 자체를 삭제합니다.
  • 삭제된 프로모션이 상품에 적용된 가장 할인율이 높은 프로모션이었다면 다음 할인율이 높은 프로모션으로 바꿔줍니다.
  • Delete Cascading 제약조건을 걸어서 데이터 정합성 보장

URL

  • DELETE /api/promotion/{promotionId}

Request

  • None

Response

  • 성공(200)

  • 실패

    • 프로모션 주인이 아닐 때(400)
   "message" : "권한이 없습니다."

Clone this wiki locally