서버 API 명세서

API 명세서

상세

POST /api/room

채팅방을 생성합니다.

Request

{
	"title": STRING // 방 제목
	"isPrivate": STRING // 'true' | 'false'	
}

제약 조건

• title 은 2자 이상, 30자 이하.
• Redis는 boolean을 지원하지 않아서 문자열로 받습니다.

Response (성공 시)

HTTP HEADER
status: 200

const roomInfo = api();

HTTP BODY
{  

		"roomCode": STRING, // 입장 코드
		"title": STRING // 방 제목
		"isPrivate": STRING // 'true' | 'false'

}

---

GET /api/room

공개채팅방 목록을 반환합니다.

Request

QUERY // 없음

Response

HTTP HEADER
status: 200

HTTP BODY
{
		rooms: {
		"roomCode": STRING,
		"title": STRING,
		"createdAt": DATETIME(STRING),
		"participantCount": NUMBER,
		"isPrivate": 'false'
		}[] // ARRAY
}

보내는 모든 방은 서버에서 isPrivate: false 인 방만 보내게 된다.

Response (잘못된 형식의 Request가 요청되었을 때)

HTTP HEADER
status: 400

HTTP BODY // 없음

Response (서버 에러)

HTTP HEADER
status: 500

HTTP BODY // 없음

---

GET /api/room/participants

Request

params: roomCode
ex) 0.0.0.0:3000/api/room/participants/A12B

제약 조건

• roomCode 는 4자의 숫자 + 영어 대문자 조합

Response (성공 시)

HTTP HEADER
status: 200

HTTP BODY
{
	"participants": ARRAY, // [{socketId, nickName, language}]
}

Response (잘못된 형식의 Request가 요청되었을 때)

• roomCode의 값이 잘못된 형태로 들어왔을 때.

HTTP HEADER
status: 400

HTTP BODY // 없음

Response (방이 없을 때)

HTTP HEADER
status: 406

HTTP BODY // 없음

Response (서버 에러)

HTTP HEADER
status: 500

HTTP BODY // 없음

---

POST /api/join

Request

{
	"roomCode": STRING // 방 제목
	"isPrivate": STRING // 'true' | 'false'
}

제약 조건

• roomCode 는 4자의 숫자 + 영어 대문자 조합

Response (성공 시)

HTTP HEADER
status: 200

HTTP BODY
{
	"roomCode": STRING, // 입장 코드
	"title": STRING // 방 제목
	"isPrivate": 'true' | 'false'
}

Response (잘못된 형식의 Request가 요청되었을 때)

• isPrivate의 값이 잘못된 형태로 들어왔을 때.

HTTP HEADER
status: 400

HTTP BODY // 없음

Response (방이 없을 때)

HTTP HEADER
status: 406

HTTP BODY // 없음

Response (서버 에러)

HTTP HEADER
status: 500

HTTP BODY // 없음

---

GET /api/profileImage

Request

// 없음

Response (성공 시)

HTTP HEADER
status: 200

HTTP BODY
{
	"imageLink": STRING
}

Response (잘못된 형식의 Request가 요청되었을 때)

HTTP HEADER
status: 400

HTTP BODY // 없음

Response (서버 에러)

HTTP HEADER
status: 500

HTTP BODY // 없음