자몽 웹사이트 API
  • Welcome!
  • Reference
    • API Reference
      • User
      • Volunteer
      • Post
      • Application
Powered by GitBook
On this page
  • POST
  • 게시물 등록
  • GET
  • 전체 게시물 조회
  • 게시물 조회
  • PATCH
  • 게시물 정보 변경
  • DELETE
  • 게시물 삭제
  1. Reference
  2. API Reference

Post

게시물 관련 요청

POST

게시물 등록

POST URL/v1/posts

새로운 게시물을 등록합니다.

Request Body

Name
Type
Description

title*

string

제목

author*

작성자

d_day*

봉사 일시

apply_day*

String

신청 일시

maximum_person

String

모집 최대 인원 (default = 0)

content*

String

내용

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

GET

전체 게시물 조회

GET URL/v1/posts

데이터 베이스에있는 게시물들을 페이지에 맞게 조회합니다. page_number 파라미터값을 입력하지 않는다면, 자동으로 1부터 10까지의 게시물을 조회합니다.

Request Body

Name
Type
Description

page_number

String

페이지 넘버 (default = 1)

{
    // Response
}
{
    // Response
}

PageNo는 1이면 1 -10, 2이면 11-20과 같이 페이지에 맞는 봉사활동을 10개씩 가져옵니다.

게시물 조회

GET URL/v1/posts/{id}

id에 해당하는 게시물을 조회합니다.

{
    // Response
}
{
    // Response
}

PATCH

게시물 정보 변경

PATCH URL/v1/posts/{id}

id에 해당하는 게시물의 정보를 변경합니다.

Request Body

Name
Type
Description

title*

string

제목

author*

작성자

d_day*

봉사 일시

apply_day*

String

신청 일시

maximum_person*

String

모집 최대 인원 (default = 0)

content*

String

내용

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

DELETE

DELETE 요청은 게시물 작성자 혹은 운영진 등급의 사용자만이 삭제할 수 있습니다.

게시물 삭제

DELETE URL/v1/posts/{id}

id에 해당하는 신청의 정보를 데이터베이스에서 삭제합니다.

{
    // Response
}
{
    // Response
}
PreviousVolunteerNextApplication

Last updated 3 years ago