API 스펙

스웨거 주소(로컬)

Swagger UI

http://maenguin.iptime.org:8080/swagger-ui/index.html#

변경 이력

• 여기에 변경 사항을 적어주세요

• 프론트분들은 보셨으면 체크 해주세요!

API 인증 통과하기

1. oauth2 인증 요청하기

{서버주소}/oauth2/authorization/{sns타입}?redirect_uri={프론트가 토큰을 받을 페이지}

예시
http://maenguin.iptime.org:8080/oauth2/authorization/kakao?redirect_uri=http://localhost:3000/oauth/redirect

예시
http://localhost:3000/oauth/redirect?token=ekraweklfawneflkan.asdflkasndflksan.sadflkas

2. 토큰으로 api 요청하기

토큰 요청 예시
X-GOLDDDUCK-AUTH : Bearer {토큰}

• X-GOLDDDUCK-AUTH 라는 헤더에 담는다

• Bearer 다음에 한칸 띄우고 토큰을 담아서 보내야함

공통 응답

{
	"success": true
  "data": {
    "content": "string",
    "giftType": "IMAGE",
    "id": 0,
    "used": true
  },
  "error": null
  "serverDateTime": "yyyy-MM-dd HH:mm:ss",
}

{
  "success": false,
  "data": null,
  "error": {
    "code": "E001", 
    "message": "해당 엔티티를 찾을 수 없습니다. name : com.dokev.gold_dduck.event.domain.Event, id : 0 "
  },
  "serverDateTime": "2021-12-09 19:41:11"
}

이벤트 생성

{
	"title": "event1"
	"maxParticipantCount": 10,
	"mainTemplate": "template1",
  "giftChoiceType": "FIFO",
  "gifts": [
    {
			"id": number,
      "category": "string",
      "giftItems": 
        {
          "content": "string",
          "giftType": "TEXT"
					"image" : null
        },
        {
          "content": null,
          "giftType": "IMAGE"
					"image" : file
        }
      ]
    }
  ],
 	"startAt": "2021-12-09T11:23:05.379Z",
  "endAt": "2021-12-09T11:23:05.379Z",
  "memberId": 0,
}

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

이벤트 조회

이벤트 단건 조회

/api/v1/events/3fa85f64-5717-4562-b3fc-2c963f66afa6

{
	"eventId": 0,
  "code": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	"startAt": "2021-12-09T10:53:39.275Z" 
  "endAt": "2021-12-09T10:53:39.274Z",
  "eventProgressStatus": "string",  
  "giftChoiceType": "FIFO",
	"mainTemplate": "string",
  "maxParticipantCount": 0,
  "gifts": [
    {
			"id": 0,
      "category": "string",
			"itemCount": 0
      "giftItems": [
        {
					"id": 0,
          "content": "string",
          "giftType": "IMAGE",
          "used": true
        }
      ],
    }
  ],
  "member": {
    "email": "string",
    "id": 0,
    "name": "string",
    "profileImage": "string",
    "socialId": "string"
  },
  
}

이벤트 전체 조회 - 생성일 DESC

/api/v1/members/1/events?eventProgressStaus=CLOSED&page=0&size=4

{
    "pagination": {
      "currentPage": 0,
      "offset": 0,
      "size": 0,
      "totalElements": 0,
      "totalPages": 0
    },
    "simpleEventList": [
      {
        "code": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "string",
        "endAt": "string",
        "eventId": 0,
        "eventProgressStatus": "CLOSED",
        "giftChoiceType": "FIFO",
        "mainTemplate": "string",
        "maxParticipantCount": 0,
        "startAt": "string",
        "title": "string"
      }
    ]
  }

선물 수령

선착순

{
  "eventId": 0,
  "giftId": 0,
  "memberId": 0
}

{
  "category": "string",
  "content": "string",
  "giftType": "IMAGE",
  "id": 0,
  "used": true,
	"mainTemplate": "string"
}

랜덤

{
  "eventId": 0,
  "memberId": 0
}

{
  "category": "string",
  "content": "string",
  "giftType": "IMAGE",
  "id": 0,
  "used": true,
	"mainTemplate": "string"
}

선물 조회

선물 전체 조회 - 수령일 DESC

/api/v1/members/1/gifts?used=&page=0&size=4

{
	"pagination": {
    "currentPage": 0,
    "offset": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  },
  "giftItemList": [
    {
      "category": "string",
      "content": "string",
      "giftType": "IMAGE",
      "id": 0,
      "used": true,
			"mainTemplate": "string"
    }
  ]
}

선물 변경

{
	"success": true
  "data": null,
  "error": null
  "serverDateTime": "yyyy-MM-dd HH:mm:ss",
}

유저 정보 조회

{
  "email": "string",
  "id": 0,
  "name": "string",
  "profileImage": "string",
  "socialId": "string"
}

이벤트 당첨자 조회

/api/v1/members/1/1/winners

• data

• winners

이벤트 삭제

/api/v1/members/1/events/1

• data

선물 아이템 단일 조회(제거 예정)

/api/v1/members/1/giftItems/1

선물 아이템 단일 조회 v2