Skip to content

배포된 api 명세서

Jump to bottom
박세준 edited this page Mar 12, 2023 · 1 revision

22 03 12 22:17 기준

목차

Table of contents generated with markdown-toc

API 명세서

API 명세서 입니다.

Version: 0.1.0

/api/v1/battles

GET

Parameters
Name Located in Description Required Schema
battleStatus query 배틀이 진행중인지, 아닌지 넘겨줍니다. 값을 주지 않는다면 모든 배틀들을 조회합니다. PROGRESS END
genre query 조회하고 싶은 배트들의 장르값을 넘겨줍니다. 비어있으면 모든 장르의 배틀을 조회합니다.HIPHOP_RAP ROCK_METAL
Responses
Code Description
200 200

POST

Summary:

배틀 신청 API입니다.

Description:

배틀 신청 API입니다.

Parameters
Name Located in Description Required Schema
Authorization header Hype 서비스 Access Token Yes string
Responses
Code Description
201 201
400 400
404 404

/api/v1/genres

GET

Responses
Code Description
200 200

/api/v1/posts

GET

Parameters
Name Located in Description Required Schema
genre query 필터링 할 장르 값 (null 가능) No string
possible query 대결 가능 여부 (null 가능) No string
Responses
Code Description
200 200

POST

Responses
Code Description
201 201
400 400

/api/v1/auth/login-check

GET

Summary:

사용자가 로그인 했는지 여부를 체크합니다.

Description:

사용자가 로그인 했는지 여부를 체크합니다.

Parameters
Name Located in Description Required Schema
Authorization header Hype 서비스 Access Token Yes string
Responses
Code Description
200 200
401 401

/api/v1/battles/details

GET

Responses
Code Description
200 200

/api/v1/battles/random

GET

Responses
Code Description
200 200
400 400

/api/v1/battles/vote

POST

Responses
Code Description
200 200

/api/v1/battles/{battleId}

GET

Parameters
Name Located in Description Required Schema
battleId path 대결 ID Yes number
Authorization header HYPE 서비스 access token Yes string
Responses
Code Description
200 200
401 401
404 404

/api/v1/members/battles

GET

Parameters
Name Located in Description Required Schema
memberId query 조회할 대결 참여자(유저) id 값 No string
battleStatus query 대결 상태 값 (PROGRESS or END) No string
genre query 대결 장르 값 No string
limit query 제한할 리스트 길이 No string
Responses
Code Description
200 200

/api/v1/members/likes

GET

Parameters
Name Located in Description Required Schema
genre query 음악 장르 이름 (값을 넣지 않으면 전체 장르 조회, 넣으면 해당 장르 조회 No string
limit query 응답 데이터 개수 (값을 넣지 않으면 전체 조회, 넣으면 해당 개수 조회 No string
Authorization header HYPE 서비스 access token Yes string
Responses
Code Description
200 200

/api/v1/members/posts

GET

Parameters
Name Located in Description Required Schema
memberId query 유저 ID (값이 안넣으면 마이페이지, 넣으면 유저 페이지 조회) No string
genre query 추천 게시글 장르 (값이 안넣으면 all, 넣으면 해당 장르 필터링) No string
limit query 게시글 개수 (값이 안넣으면 전체 조회, 넣으면 해당 개수 조회) No string
Responses
Code Description
200 200
404 404

/api/v1/members/profile

GET

Parameters
Name Located in Description Required Schema
memberId query 멤버 ID (값이 없으면 마이페이지, 있으면 memberId로 들어오는 유저의 유저페이지) No string
Responses
Code Description
200 200
404 404

/api/v1/members/ranking

GET

Summary:

유저 랭킹 top100 조회 랭킹순으로 정렬

Description:

유저 랭킹 top100 조회 랭킹순으로 정렬

Responses
Code Description
200 200

/api/v1/music/search

GET

Parameters
Name Located in Description Required Schema
term query 음악 검색 요청문 Yes string
Responses
Code Description
200 200

/api/v1/posts/{postId}

GET

Parameters
Name Located in Description Required Schema
postId path 조회할 공유 게시글 id Yes string
Responses
Code Description
200 200
404 404

/api/v1/members/profile/image

POST

Parameters
Name Located in Description Required Schema
Authorization header HYPE 서비스 Access Token Yes string
Responses
Code Description
200 200

/api/v1/members/profile/nickname

POST

Parameters
Name Located in Description Required Schema
Authorization header HYPE 서비스 Access Token Yes string
Responses
Code Description
200 200

/api/v1/members/ranking/preview

GET

Summary:

유저 랭킹 top5 조회 랭킹순으로 정렬

Description:

유저 랭킹 top5 조회 랭킹순으로 정렬

Responses
Code Description
200 200

/api/v1/posts/likes/top

GET

Parameters
Name Located in Description Required Schema
genre query 필터링 할 장르 값 (null 가능) No string
Responses
Code Description
200 200

/api/v1/posts/{postId}/isLike

GET

Parameters
Name Located in Description Required Schema
postId path 추천글 id Yes string
Responses
Code Description
200 200

/api/v1/posts/{postId}/like

POST

Parameters
Name Located in Description Required Schema
postId path 추천글 id Yes string
Responses
Code Description
200 200

/api/v1/posts/battle/{postId}/candidates

GET

Parameters
Name Located in Description Required Schema
postId path 대결 신청할 추천글 id Yes string
Responses
Code Description
200 200
400 400

/health

GET

Summary:

헬스체크 api 입니다.

Description:

헬스체크 api 입니다.

Parameters
Name Located in Description Required Schema
name query 이름을 담습니다. default : test Yes string
Responses
Code Description
200 200
Clone this wiki locally