A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | �Category | Description | Method | URL | Request Headers | Request Body | Response Headers | Response Body - 성공 | Response Body - 실패 | 비고 | ||||||||||||||||
2 | 인증 | 회원가입 | POST | /user/signup | Content-Type: application/json | # 데이터 타입 { "email": string, "password": string, "passwordConfirm": string, "role": enum, "name":string } # 예시 { "email": "example00@naver.com", "password": "example00", "passwordConfirm": "example00", "role": "admin", "name":"김윤찬" } | # 데이터 타입 { "status": number, "message": string, "data": object } # 예시 - StatusCode: 200 - 회원가입 성공 { "status": number, "message": "회원가입에 성공했습니다.", "data": { "id": 1, "email": "example00@naver.com", "name": "김윤찬", "createdAt": "2023-11-05T12:50:10.214Z", "updatedAt": "2023-11-05T12:50:10.214Z" } } | # 데이터 타입 { "success": boolean, "message": string } # 예시 - StatusCode: 400 - 이메일 정보가 없는 경우 { "success": false, "message": "이메일 입력이 필요합니다." } - StatusCode: 409 - 중복 된 이메일인 경우 { "success": false, "message": "이미 가입 된 이메일입니다." } | ||||||||||||||||||
3 | 인증 | 로그인 | POST | Content-Type: application/json | # 데이터 타입 { "email": string, "password": string, } # 예시 { "email": "example00@naver.com", "password": "example00" } | Authorization : “Bearer {token}” | # 데이터 타입 { "success": boolean, "message": string, "data": object } # 예시 - StatusCode: 200 - 로그인 성공 { "success": true, "message": "로그인에 성공했습니다.", "data": { "id": 1, } } | |||||||||||||||||||
4 | 프로필 보기 | GET | Authorization : “Bearer {token}” | #데이터 타입 { "name":string, "point":number } # 예시 - StatusCode: 200 - 프로필 조회 성공 { "name":"김윤찬", "point": 30,000 } | ||||||||||||||||||||||
5 | 공연 등록 | POST | /performances | Content-Type: application/json Authorization : “Bearer {token}” | #데이터 타입 { "name": string, "description": string, "datetime": datetime, "place":string, "seat":number, "image":blob, "category":string } # 예시 { "name": 2023 리뉴얼 풍물놀이, "description": 실감나는 장구 소리, "datetime": 2023-12-31 12:30:00, "place": 부천종합운동장, "seat": 230, "image": image.png, "category": 민속놀이 } | # 데이터 타입 { "status": number, ”message”: string ”data” :object } # 예시 - StatusCode: 201 - 공연 등록 성공 { ”status” : 201, ”message”: “공연 등록에 성공했습니다.“, ”data” : { "name": 2023 리뉴얼 풍물놀이, "description": 실감나는 장구 소리, "datetime": 2023-12-31 12:30:00, "place": 부천종합운동장, "seat": 230, "image": image.png, "category": 민속놀이 } } | ||||||||||||||||||||
6 | 공연 목록 보기 | GET | /performances | # 데이터 타입 { “status": number, "message": string, "data": object } # 예시 - StatusCode: 200 - 공연 목록 불러오기 성공 { “status": 200, “message”:”공연 목록 조회에 성공했습니다.”, "data": { “id”:1 } } | ||||||||||||||||||||||
7 | 공연 검색 | GET | /performances/search?keyword= | Content-Type: application/json | # 데이터 타입 { "status": number, ”data": object } # 예시 - StatusCode: 200 - 해당 공연 검색 성공 { "name": 2023 리뉴얼 풍물놀이, "description": 실감나는 장구 소리, "datetime": 2023-12-31 12:30:00, "place": 부천종합운동장, "seat": 230, "image": image.png, "category": 민속놀이 } | |||||||||||||||||||||
8 | 공연 상세보기 | GET | /performances/:performanceId | # 데이터 타입 { "status": number, ”data": object } # 예시 - StatusCode: 200 - 해당 공연 조회 성공 { "name": 2023 리뉴얼 풍물놀이, "description": 실감나는 장구 소리, "datetime": 2023-12-31 12:30:00, "place": 부천종합운동장, "seat": 230, "image": image.png, "category": 민속놀이 } | ||||||||||||||||||||||
9 | 공연 예매 | POST | /reservation/:userId | Content-Type: application/json Authorization : “Bearer {token}” | # 데이터 타입 { "date":2023-12-31 12:30:00, "place":"부천종합운동장" } | # 데이터 타입 { "status": number, ”message”: string ”data” :object } # 예시 - StatusCode: 201 - 공연 예약 성공 { ”status” : 201, ”message”: “예약에 성공했습니다.“, ”data” : { “date”:2023-12-30 12:30:00, "place":"부천종합운동장" } } | ||||||||||||||||||||
10 | 예매 확인 | GET | /reservation/:userId | Authorization : “Bearer {token}” | # 데이터 타입 { "status": number, ”message”: string ”data” :object } # 예시 - StatusCode: 200 - 예약 조회 성공 { ”status” : 200, ”message”: “예약에 성공했습니다.“, ”data” : { “date”:2023-12-12, "place":"부천종합운동장" } } | |||||||||||||||||||||
11 | ||||||||||||||||||||||||||
12 | ||||||||||||||||||||||||||
13 | ||||||||||||||||||||||||||
14 | ||||||||||||||||||||||||||
15 | ||||||||||||||||||||||||||
16 | ||||||||||||||||||||||||||
17 | ||||||||||||||||||||||||||
18 | ||||||||||||||||||||||||||
19 | ||||||||||||||||||||||||||
20 | ||||||||||||||||||||||||||
21 | ||||||||||||||||||||||||||
22 | ||||||||||||||||||||||||||
23 | ||||||||||||||||||||||||||
24 | ||||||||||||||||||||||||||
25 | ||||||||||||||||||||||||||
26 | ||||||||||||||||||||||||||
27 | ||||||||||||||||||||||||||
28 | ||||||||||||||||||||||||||
29 | ||||||||||||||||||||||||||
30 | ||||||||||||||||||||||||||
31 | ||||||||||||||||||||||||||
32 | ||||||||||||||||||||||||||
33 | ||||||||||||||||||||||||||
34 | ||||||||||||||||||||||||||
35 | ||||||||||||||||||||||||||
36 | ||||||||||||||||||||||||||
37 | ||||||||||||||||||||||||||
38 | ||||||||||||||||||||||||||
39 | ||||||||||||||||||||||||||
40 | ||||||||||||||||||||||||||
41 | ||||||||||||||||||||||||||
42 | ||||||||||||||||||||||||||
43 | ||||||||||||||||||||||||||
44 | ||||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | ||||||||||||||||||||||||||
48 | ||||||||||||||||||||||||||
49 | ||||||||||||||||||||||||||
50 | ||||||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 |