Skip to content

Latest commit

 

History

History
639 lines (511 loc) · 13.2 KB

File metadata and controls

639 lines (511 loc) · 13.2 KB
title Default module
language_tabs
shell
Shell
http
HTTP
javascript
JavaScript
ruby
Ruby
python
Python
php
PHP
java
Java
go
Go
toc_footers
includes
search true
code_clipboard true
highlight_theme darkula
headingLevel 2
generator @tarslib/widdershins v4.0.30

Default module

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

ddib/로그인

POST 카카오로그인

POST /api/auth/login/kakao

Params

Name Location Type Required Description
code query string no none

Response Examples

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "user": {
    "userId": 0,
    "nickname": "string",
    "role": "string"
  }
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» accessToken string true none none
» refreshToken string true none none
» user object true none none
»» userId integer true none none
»» nickname string true none none
»» role string true none none

POST 리프레시

POST /api/auth/refresh

Body Parameters

{
  "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZGliIiwic3ViIjoiMSIsImF1ZCI6ImRkaWIiLCJpYXQiOjE3NzAxMjQ3ODUsImV4cCI6MTc3MTMzNDM4NSwibmFtZSI6IuyXhOycoOyDgSIsInJvbGUiOiJVU0VSIiwidG9rZW5UeXBlIjoiUkVGUkVTSCIsImp0aSI6ImFjODZkMmY2LWZiNDUtNGMzMy04ZDhhLTRiOThjZjE4OGViYiJ9.rSV59dNz7UWUQnfH1oycj3xjXxOwzVEDlXFciUGOCfY"
}

Params

Name Location Type Required Description
body body object yes none

Response Examples

200 Response

{
  "accessToken": "string",
  "refreshToken": "string"
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» accessToken string true none none
» refreshToken string true none none

POST 테스트로그인

POST /api/auth/test/login

Params

Name Location Type Required Description
userId query string no none

Response Examples

200 Response

{}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

ddib/대기열

POST 대기열 입장

POST /api/queue/in

Body Parameters

{
  "performanceId": 1,
  "optionId": 1
}

Params

Name Location Type Required Description
body body object yes none

Response Examples

404 Response

{
  "timestamp": "string",
  "statusCode": 0,
  "errorCode": "string",
  "message": "string",
  "path": "string"
}

Responses

HTTP Status Code Meaning Description Data schema
404 Not Found none Inline

Responses Data Schema

HTTP Status Code 404

Name Type Required Restrictions Title description
» timestamp string true none none
» statusCode integer true none none
» errorCode string true none none
» message string true none none
» path string true none none

GET 대기열 SSE

GET /api/queue/status

Params

Name Location Type Required Description
performanceId query string no none
optionId query string no none

Response Examples

200 Response

{}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

ddib/결제

POST 결제준비

POST /api/payments/prepare

Body Parameters

{
  "tokenId": "token-003",
  "performanceId": 10,
  "optionId": 1,
  "seatIds": [
    10,
    11
  ]
}

Params

Name Location Type Required Description
ddib.store/api/payments/prepare query string no none
body body object yes none

Response Examples

200 Response

{
  "orderId": "string",
  "amount": 0,
  "currency": "string",
  "orderName": "string",
  "customerKey": "string",
  "successUrl": "string",
  "failUrl": "string",
  "expiresAt": "string"
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» orderId string true none none
» amount integer true none none
» currency string true none none
» orderName string true none none
» customerKey string true none none
» successUrl string true none none
» failUrl string true none none
» expiresAt string true none none

POST 결제취소

POST /api/payments/confirm

Body Parameters

{
  "orderId": "ORDER-20260201-401806",
  "paymentKey": "tviva20260201174444u2UN9",
  "amount": 100
}

Params

Name Location Type Required Description
body body object yes none

Response Examples

200 Response

{}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

ddib/공연조회

GET 공연 조회

GET /api/ticketing/performances

Response Examples

200 Response

{
  "content": [
    {
      "issuedAt": "string",
      "optionId": 0,
      "optionStartAt": "string",
      "performanceId": 0,
      "performanceImg": "string",
      "performanceTitle": "string",
      "price": 0,
      "seatId": 0,
      "seatLabel": "string",
      "seatNumber": 0,
      "status": "string",
      "ticketId": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» content [object] true none none
»» issuedAt string false none none
»» optionId integer false none none
»» optionStartAt string false none none
»» performanceId integer false none none
»» performanceImg string false none none
»» performanceTitle string false none none
»» price integer false none none
»» seatId integer false none none
»» seatLabel string false none none
»» seatNumber integer false none none
»» status string false none none
»» ticketId integer false none none
» empty boolean true none none
» first boolean true none none
» last boolean true none none
» number integer true none none
» numberOfElements integer true none none
» pageable object true none none
»» offset integer true none none
»» pageNumber integer true none none
»» pageSize integer true none none
»» paged boolean true none none
»» sort object true none none
»»» empty boolean true none none
»»» sorted boolean true none none
»»» unsorted boolean true none none
»» unpaged boolean true none none
» size integer true none none
» sort object true none none
»» empty boolean true none none
»» sorted boolean true none none
»» unsorted boolean true none none
» totalElements integer true none none
» totalPages integer true none none

ddib/티켓조회

GET 내 티켓 조회

GET /api/ticketing/tickets/me

Response Examples

200 Response

{
  "content": [
    {
      "issuedAt": "string",
      "optionId": 0,
      "optionStartAt": "string",
      "performanceId": 0,
      "performanceImg": "string",
      "performanceTitle": "string",
      "price": 0,
      "seatId": 0,
      "seatLabel": "string",
      "seatNumber": 0,
      "status": "string",
      "ticketId": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» content [object] true none none
»» issuedAt string false none none
»» optionId integer false none none
»» optionStartAt string false none none
»» performanceId integer false none none
»» performanceImg string false none none
»» performanceTitle string false none none
»» price integer false none none
»» seatId integer false none none
»» seatLabel string false none none
»» seatNumber integer false none none
»» status string false none none
»» ticketId integer false none none
» empty boolean true none none
» first boolean true none none
» last boolean true none none
» number integer true none none
» numberOfElements integer true none none
» pageable object true none none
»» offset integer true none none
»» pageNumber integer true none none
»» pageSize integer true none none
»» paged boolean true none none
»» sort object true none none
»»» empty boolean true none none
»»» sorted boolean true none none
»»» unsorted boolean true none none
»» unpaged boolean true none none
» size integer true none none
» sort object true none none
»» empty boolean true none none
»» sorted boolean true none none
»» unsorted boolean true none none
» totalElements integer true none none
» totalPages integer true none none

GET 내 티켓 상세

GET /api/ticketing/tickets/me/1

Response Examples

200 Response

{
  "content": [
    {
      "issuedAt": "string",
      "optionId": 0,
      "optionStartAt": "string",
      "performanceId": 0,
      "performanceImg": "string",
      "performanceTitle": "string",
      "price": 0,
      "seatId": 0,
      "seatLabel": "string",
      "seatNumber": 0,
      "status": "string",
      "ticketId": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Responses

HTTP Status Code Meaning Description Data schema
200 OK none Inline

Responses Data Schema

HTTP Status Code 200

Name Type Required Restrictions Title description
» content [object] true none none
»» issuedAt string false none none
»» optionId integer false none none
»» optionStartAt string false none none
»» performanceId integer false none none
»» performanceImg string false none none
»» performanceTitle string false none none
»» price integer false none none
»» seatId integer false none none
»» seatLabel string false none none
»» seatNumber integer false none none
»» status string false none none
»» ticketId integer false none none
» empty boolean true none none
» first boolean true none none
» last boolean true none none
» number integer true none none
» numberOfElements integer true none none
» pageable object true none none
»» offset integer true none none
»» pageNumber integer true none none
»» pageSize integer true none none
»» paged boolean true none none
»» sort object true none none
»»» empty boolean true none none
»»» sorted boolean true none none
»»» unsorted boolean true none none
»» unpaged boolean true none none
» size integer true none none
» sort object true none none
»» empty boolean true none none
»» sorted boolean true none none
»» unsorted boolean true none none
» totalElements integer true none none
» totalPages integer true none none

Data Schema