API 목록

스터디 생성

호출한 회원은 스터디원으로 등록됩니다.

요청

Request

POST /studies HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2OTUiLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.Re5-sDlpsrJyVCP8NwQOguAl_17W6G7_tFmwbve0Fsc

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=request
Content-Type: application/json

{"title":"자바 스터디","information":"자바 스터디 입니다","year":2023,"season":1,"gitLink":"https://docs.api.com/KEEPER31337/Homepage-Back-R2","notionLink":"https://docs.api.com/Java-Spring","etcTitle":"ETC","etcLink":"https://docs.api.com","memberIds":[696]}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=thumbnail; filename=testImage_1x1.png
Content-Type: image/png

�PNG


IHDR%�V�PLTE�z=�tRNS@��f
IDAT�c`�!�3IEND�B`�
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원) 스터디 생성자는 스터디장이 됩니다.

Request Fields

링크는 하나 이상 필수입니다.
Path Type Description

title

String

스터디 이름을 입력해주세요. (최대 가능 길이 : 45)

information

String

스터디 설명을 입력해주세요. (최대 가능 길이 : 100)

year

Number

스터디 년도를 입력해주세요.

season

Number

스터디 학기를 입력해주세요.

gitLink

String

스터디 깃허브 링크를 입력해주세요.

notionLink

String

스터디 노션 링크를 입력해주세요.

etcTitle

String

스터디 기타 자료 제목을 입력해주세요.

etcLink

String

스터디 기타 링크를 입력해주세요.

memberIds[]

Array

스터디원 Id 리스트를 입력해주세요.

Request Parts

파트명 필수값 설명

request

true

스터디 정보

thumbnail

스터디의 썸네일

응답

Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

스터디 삭제

요청

Request

DELETE /studies/10 HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2OTEiLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.IV6Hp9f4CjeTims-eCLfqnYWEeWb7JLWkbHCwtbthxI

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 1. /studies/{studyId}
Parameter Description

studyId

삭제하고자 하는 스터디의 ID

응답

Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

스터디 목록 조회

요청

Request

GET /studies?year=2023&season=1 HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2ODMiLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.RV6hovbQOu3MNNLYwDva-S9u35KjNhyoaESmj1Ei9Qg

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원)

Query Parameters

파라미터명 필수값 양식 설명

year

true

조회하고자 하는 스터디 년도

season

true

조회하고자 하는 스터디 학기

응답

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 177

{
  "studies" : [ {
    "studyId" : 7,
    "title" : "스터디명",
    "headId" : 685,
    "headName" : "BlTtMQjWsR",
    "memberCount" : 0,
    "thumbnailPath" : null
  } ]
}

Response Fields

Path Type Description

studies[].studyId

Number

스터디 ID

studies[].thumbnailPath

Null

스터디 썸네일 경로

studies[].title

String

스터디 이름

studies[].headId

Number

스터디장 ID

studies[].headName

String

스터디장 이름 (실명)

studies[].memberCount

Number

스터디원 수

스터디 조회

요청

Request

GET /studies/9 HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2ODciLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.-bQHMmBJt8dI0EjjvWKKu4iLc2tPBmRl-14MaajcJe4

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 2. /studies/{studyId}
Parameter Description

studyId

조회하고자 하는 스터디의 ID

응답

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 496

{
  "information" : "스터디 소개",
  "headMember" : {
    "memberId" : 689,
    "generation" : "15.0",
    "realName" : "hOYcnwYhzj"
  },
  "members" : [ {
    "memberId" : 690,
    "generation" : "15.0",
    "realName" : "bcyfVhGlNE"
  } ],
  "links" : [ {
    "title" : "Github",
    "content" : "https://github.com/KEEPER31337/Homepage-Back-R2"
  }, {
    "title" : "Notion",
    "content" : "https://www.notion.so/Java-Spring"
  }, {
    "title" : null,
    "content" : "etc.com"
  } ]
}

Response Fields

Path Type Description

information

String

스터디 정보

headMember.memberId

Number

스터디장 회원 ID

headMember.generation

String

스터디장 회원 기수

headMember.realName

String

스터디장 회원 이름

members[].memberId

Number

스터디원 회원 ID

members[].generation

String

스터디원 회원 기수

members[].realName

String

스터디원 회원 이름

links[]

Array

스터디 링크 리스트

links[].title

String

스터디 링크 제목

links[].content

String

스터디 링크

스터디 썸네일 수정

요청

Request

PATCH /studies/4/thumbnail HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NzkiLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.fwxWiVVlDgv3MG78EAueX52DIJi5mrt0okujH2Cr6H0

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 3. /studies/{studyId}/thumbnail
Parameter Description

studyId

스터디 ID

Request Parts

파트명 필수값 설명

thumbnail

책의 썸네일 (null 값으로 보낼 경우 기본 썸네일로 지정됩니다.)

응답

Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

스터디 수정

호출한 회원은 스터디원으로 등록됩니다.

요청

Request

PUT /studies/3 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 379
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NzciLCJyb2xlcyI6IlJPTEVf7ZqM7JuQIiwiaWF0IjoxNzExMTE5MTUwLCJleHAiOjE3MTExMjI3NTB9.10FgmA9gQpkuA89-qUV33czBvfT7lfRr0A_tpLS1zDA

{
  "title" : "자바 스터디",
  "information" : "자바 스터디 입니다.",
  "year" : 2023,
  "season" : 2,
  "gitLink" : "https://docs.api.com/KEEPER31337/Homepage-Back-R2",
  "notionLink" : "https://docs.api.com/KEEPER-NEW-HOMEPAGE-PROJECT-c4fd631881d84e4daa6fa14404ac6173?pvs=4",
  "etcTitle" : "plato",
  "etcLink" : "https://docs.api.com/",
  "memberIds" : [ 678 ]
}

Request Cookies

Name Description

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 4. /studies/{studyId}
Parameter Description

studyId

스터디 ID

Request Fields

링크는 하나 이상 필수입니다.
필드명 타입 필수값 양식 설명

title

String

true

스터디 제목 (최대 가능 길이 : 45)

information

String

true

저자 (최대 가능 길이 : 100)

year

Number

true

스터디 년도

season

Number

true

1: 1학기 2: 여름학기 3: 2학기 4: 겨울학기

스터디 학기

gitLink

String

"https://github.com"으로 시작

깃허브 링크

notionLink

String

노션 링크

etcTitle

String

기타 링크 이름

etcLink

String

기타 링크

memberIds[]

Array

true

스터디원 Id 리스트를 입력해주세요.

응답

Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /studies/3
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Response Headers

Name Description

Location

수정한 스터디를 불러오는 URI 입니다.