API docs by Redocly

Crema 백엔드 API 명세 (1.0)

Download OpenAPI specification:Download

URL: https://springdoc.org/

SpringDoc을 이용한 SwaggerAPI 문서입니다.

GuideMe

가이드 본인 API

가이드 스케줄 등록

가이드의 스케줄을 등록합니다.

Request Body schema: application/json
required
Array of objects (ScheduleRequestDTO) non-empty

Responses

Request samples

Content type
application/json
{
  • "schedules": [
    ]
}

가이드 직무 분야 등록

가이드의 직무 분야를 등록합니다.

Request Body schema: application/json
jobName
string
Enum: "JobNameType.DESIGN(description=디자인)" "JobNameType.PLANNING_STRATEGY(description=기획/전략)" "JobNameType.MARKETING_PR(description=마케팅/홍보)" "JobNameType.MANAGEMENT_SUPPORT(description=경영/지원)" "JobNameType.IT_DEVELOPMENT_DATA(description=IT 개발/데이터)" "JobNameType.RESEARCH_RND(description=연구/R&D)"

Responses

Request samples

Content type
application/json
{
  • "jobName": "JobNameType.DESIGN(description=디자인)"
}

가이드 해시태그 등록

가이드의 해시태그를 등록합니다. 최대 5개까지 등록할 수 있습니다.

Request Body schema: application/json
Array
hashTagName
string [ 0 .. 8 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

가이드 채팅 주제 등록

가이드의 채팅 주제를 등록합니다.

Request Body schema: application/json
required
Array of objects (TopicDTO)

Responses

Request samples

Content type
application/json
{
  • "topics": [
    ]
}

가이드 본인 프로필 조회

현재 로그인한 가이드의 프로필을 조회합니다.

Responses

가이드 스케줄 삭제

가이드의 스케줄을 삭제합니다.

path Parameters
timeSlotId
required
integer <int64>

Responses

가이드 해시태그 삭제

가이드의 해시태그를 삭제합니다.

path Parameters
hashTagId
required
integer <int64>

Responses

가이드 채팅 주제 삭제

가이드의 채팅 주제를 삭제합니다.

path Parameters
topicId
required
integer <int64>

Responses

Member API

회원 관리 API

내 프로필 정보 업데이트

현재 로그인한 사용자의 닉네임, 자기소개, 이메일을 업데이트합니다.

Authorizations:
JWT
query Parameters
nickname
string

닉네임

description
string

자기소개

email
string

이메일

Responses

내 프로필 이미지 업데이트

현재 로그인한 사용자의 프로필 이미지를 업로드하고 업데이트합니다.

Authorizations:
JWT
Request Body schema: multipart/form-data
image
required
string <binary>

프로필 이미지 파일

Responses

회원 정보 조회 (닉네임) - 타인용

닉네임으로 공개 회원 정보를 조회합니다.

Authorizations:
JWT
path Parameters
nickname
required
string

닉네임

Responses

내 정보 조회

현재 로그인한 사용자의 모든 정보를 조회합니다.

Authorizations:
JWT

Responses

회원 탈퇴

현재 로그인한 사용자가 회원 탈퇴를 진행합니다.

Authorizations:
JWT

Responses

회원 정보 조회 (ID) - 타인용

회원 ID로 공개 회원 정보를 조회합니다.

Authorizations:
JWT
path Parameters
memberId
required
string

회원 ID

Responses

닉네임 중복 확인

닉네임 사용 가능 여부를 확인합니다.

path Parameters
nickname
required
string

확인할 닉네임

Responses

Guide

가이드 API

가이드 스케줄 조회

특정 가이드의 스케줄을 조회합니다. 비공개 가이드인 경우 본인 가이드만 조회할 수 있습니다.

path Parameters
guideId
required
integer <int64>

Responses

가이드 직무분야 조회

특정 가이드의 직무분야를 조회합니다. 비공개 가이드인 경우 본인 가이드만 조회할 수 있습니다.

path Parameters
guideId
required
integer <int64>

Responses

가이드 해시태그 조회

특정 가이드의 해시태그를 조회합니다. 비공개 가이드인 경우 본인 가이드만 조회할 수 있습니다.

path Parameters
guideId
required
integer <int64>

Responses

가이드 챗 주제 조회

특정 가이드의 챗 주제를 조회합니다. 비공개 가이드인 경우 본인 가이드만 조회할 수 있습니다.

path Parameters
guideId
required
integer <int64>

Responses

Debug API

개발환경 디버깅용 API

간단한 헬스체크

서버가 살아있는지 확인

Responses

환경설정 확인

현재 서버의 주요 환경설정을 확인합니다.

Responses

Auth API

인증 관련 API

토큰 갱신

Refresh Token을 사용하여 새로운 Access Token을 발급받습니다.

Responses

로그아웃

쿠키에서 JWT 토큰을 삭제하고 토큰을 블랙리스트에 추가하여 로그아웃 처리합니다.

Authorizations:
JWT

Responses

로그인 상태 확인

현재 로그인 상태를 확인합니다.

Responses

Image API

이미지 업로드/삭제/조회 API

이미지 업로드 (범용)

지정된 폴더에 이미지를 업로드합니다. 지원 형식: JPEG, PNG, GIF, WebP (최대 10MB)

Authorizations:
JWT
query Parameters
folder
required
string

S3 폴더명 (택 1: profile-images, chat-images, guide-posts, test-images)

Request Body schema: multipart/form-data
image
required
string <binary>

업로드할 이미지 파일

Responses

이미지 URL 조회

이미지의 Presigned URL을 생성합니다. (2분간 유효)

Authorizations:
JWT
query Parameters
imageKey
required
string

조회할 이미지의 S3 키

Responses

이미지 삭제

S3에서 이미지를 삭제합니다. imageKey는 전체 경로를 포함해야 합니다.

Authorizations:
JWT
query Parameters
imageKey
required
string

삭제할 이미지의 S3 키 (예: study-diary-images/user123_20241201_image.jpg)

Responses