StudyGroup

ward-study 어플리케이션에서 가장 중요한 스키마이므로, 전체 목록조회와 카테고리별 조회 기능을 제공할 예정. 캐싱 기능이 적용 된 상태라면 같은 값으로 요청을 보내 캐시된 데이터를 읽어오는 것도 고려중.

Creating a study-group

스터디그룹 등록

POST https://api.myapi.com/v1/user/{userId}/study-group

Creates a study-group.

Request Body

Name
Type
Description

title*

string

The title of the stduy-group

content*

string

The content of the stduy-group

{
    "title"="JPA-STUDY",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "content": "java book with ppt",
    "number_group": 7,
    "min_size": 2,
    "max_size": 8
}

Getting stduy-group

전체 스터디그룹 조회

GET https://api.myapi.com/v1/stduy-group

getting stduy-groups.

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Getting newsfeed stduy-group

뉴스피드용 사용자가 등록된 스터디그룹 조회

GET https://api.myapi.com/v1/user/{userId}/stduy-group

getting stduy-groups.

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Getting a stduy-group

스터디그룹 상세보기

GET https://api.myapi.com/v1/stduy-group/{stduy-groupId}

Path Parameters

Name
Type
Description

stduy-groupId*

Long

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Updating a study-group

스터디그룹 수정

PUT https://api.myapi.com/v1/users/{userId}/study-group/{stduy-groupId}

Update a stduy-group.

Path Parameters

Name
Type
Description

userId*

Long

studyGroupId*

Long

Request Body

Name
Type
Description

title

string

The title of the stduy-group

content

string

The content of the stduy-group

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Deleting a stduy-group

스터디그룹 삭제

DELETE https://api.myapi.com/v1/users/{userId}/stduy-group/{stduy-groupId}

getting stduy-groups.

Path Parameters

Name
Type
Description

stduy-groupId*

Long

userId*

Long

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Last updated