✍️Post
글 모델인 Post에 대한 API입니다.
특정 글을 조회합니다.
GET localhost:8080/post
id를 활용하여 특정 글을 조회할 수 있습니다.
Path Parameters
id*
Long
목표 글의 id
여러 글들을 조회합니다.
GET http://localhost:8080/posts
작성자, 제목, 본문, 페이지 조건을 활용해 여러 글을 조회합니다.
Query Parameters
writer
String
글을 작성한 작성자
title
String
글의 제목 (포함 여부로 판단)
content
String
글의 본문 (포함 여부로 판단)
page
Long
조회된 결과물의 특정 페이지
글을 생성합니다.
POST http://localhost:8080/post
제목과 본문 내용을 활용하여 글을 생성합니다. 작성자는 익명으로 설정됩니다.
Request Body
title*
String
글 제목
content*
String
글 본문
{
"id": 4,
"writer": "익명",
"title": "네 번째 글 작성",
"content": "네 번째 글 작성입니다."
}id: 글의 PK를 뜻합니다.
writer: 작성자를 뜻합니다. 원래는 User 등의 클래스와 묶여 FK가 되어야 하지만, 지금은 Post 모델에만 집중했기 때문에 “익명”으로 설정합니다.
title: 글의 제목을 뜻합니다.
content: 글의 본문을 뜻합니다.
{
"message": "validation error"
}글의 title이나 content가 없다면 위와 같은 오류를 반환합니다.
{
"timestamp": "2023-05-11T17:12:13.612+00:00",
"status": 400,
"error": "Bad Request",
"path": "/post"
}요청 body가 아예 없다면 위와 같은 오류를 반환합니다.
글을 수정합니다.
PUT http://localhost:8080/post
id로 목표 글을 찾고 제목과 본문을 수정합니다.
Path Parameters
id*
Long
목표 글의 id
{
"id": 1,
"writer": "익명",
"title": "수정",
"content": "글 수정"
}수정된 후의 글의 정보를 반환합니다.
{
"message": "validation error"
}글의 title이나 content가 없다면 위와 같은 오류를 반환합니다.
{
"message": "target not found"
}목표 글을 아예 찾지 못했다면 위와 같은 오류를 반환합니다. title 또는 content가 없는 오류와 함께 발생한다면 validation error 오류를 반환합니다.
{
"timestamp": "2023-05-11T17:31:43.405+00:00",
"status": 400,
"error": "Bad Request",
"path": "/post/10"
}요청 body가 아예 없다면 위와 같은 오류를 반환합니다.
{
"timestamp": "2023-05-11T17:40:11.592+00:00",
"status": 405,
"error": "Method Not Allowed",
"path": "/post"
}id를 넣지 않은 채 PUT 요청을 보낼 경우 위의 오류를 반환합니다.
글을 삭제합니다.
DELETE http://localhost:8080/post
id로 목표 글을 찾고 삭제합니다.
Path Parameters
id*
Long
목표 글의 id
글 삭제 완료글이 성공적으로 삭제되었음을 알려줍니다.
{
"message": "target not found"
}목표 글을 아예 찾지 못했다면 위와 같은 오류를 반환합니다.
{
"timestamp": "2023-05-11T17:43:49.531+00:00",
"status": 405,
"error": "Method Not Allowed",
"path": "/post"
}id를 넣지 않은 채 DELETE 요청을 보낼 경우 위의 오류를 반환합니다.
Last updated