Skip to content

구현 : notices

오주환 edited this page Jul 29, 2022 · 1 revision

notices에 대한 상세 구현 문서입니다.

기능 목록

  1. 공지사항 생성
  2. 공지사항 수정
  3. 공지사항 전체 조회
  4. 공지사항 상세 조회
  5. 공지사항 삭제





공지사항 생성

URL

POST http://localhost:3000/api/notices

Request

{
    "title" : "공지사항 제목입니다.",
    "content" : "공지사항 내용입니다."
}

Response

{
    "status": 201,
    "isSuccess": true,
    "message": "성공",
    "data": [
        {
            "id": 1,
        }
    ]
}

Validation Check

  • title: 제목 글자수 45자 제한





공지사항 수정

URL

PATCH http://localhost:3000/api/notices/1

Request

{
    "title" : "공지사항 수정된 제목입니다.",
    "content" : "공지사항 수정된 내용입니다."
}

Response

{
    "status": 200,
    "isSuccess": true,
    "message": "성공"
}




공지사항 전체 조회

URL

GET http://localhost:3000/api/notices

Response

{
    "status": 200,
    "isSuccess": true,
    "message": "성공",
    "data": [
        {
            "id": 1,
            "title": "공지사항 제목입니다.",
            "createdAt": "2022-07-28T15:25:11.000Z"
        },
        {
            "id": 2,
            "title": "공지사항 제목2입니다.",
            "createdAt": "2022-07-30T11:05:11.000Z"
        }
    ]
}





공지사항 상세 조회

URL

GET http://localhost:3000/api/notices/1

Response

{
    "status": 200,
    "isSuccess": true,
    "message": "성공",
    "data": [
        {
            "id": 1,
            "title": "공지사항 수정된 제목입니다.",
            "content": "공지사항 수정된 내용입니다.",
            "createdAt": "2022-07-28T15:25:11.000Z"
        }
    ]
}





공지사항 삭제

URL

DELETE http://localhost:3000/api/notices/1

Response

{
    "status": 200,
    "isSuccess": true,
    "message": "성공"
}