유저
+
+
+
+
+
++
+
+유저 조회
+
+
+
+
+
+GET /users
+
+
+
+
+| + + | ++유저가 없을 경우 + | +
+
+
+Request
+
+
+
+
+GET /api/v1/users HTTP/1.1
+Host: localhost:8080
+
+Request
+
+
+
+
+GET /api/v1/users HTTP/1.1
+Host: localhost:8080
+
+
+
+Response
+
+
+
+
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 246
+
+[ {
+ "id" : 7,
+ "name" : "Tamra",
+ "age" : 1,
+ "hobby" : "League of Legends",
+ "createdAt" : "2023-11-24T23:41:58.747034"
+}, {
+ "id" : 9,
+ "name" : "Keven",
+ "age" : 41,
+ "hobby" : "PUBG",
+ "createdAt" : "2023-11-24T23:41:58.747243"
+} ]| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Id |
+
|
+
|
+Name |
+
|
+
|
+Age |
+
|
+
|
+Hobby |
+
|
+
|
+Creation Datetime |
+
+
+유저 생성
+
+
+
+
+
+POST /users
+
+
+Request
+
+
+
+
+POST /api/v1/users HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 75
+Host: localhost:8080
+
+{
+ "name" : "Cliff",
+ "age" : 47,
+ "hobby" : "Super Smash Bros. Melee"
+}
+
+
+
+Response
+
+
+
+
+HTTP/1.1 201 Created
+Content-Type: application/json
+Content-Length: 133
+
+{
+ "id" : 8,
+ "name" : "Cliff",
+ "age" : 47,
+ "hobby" : "Super Smash Bros. Melee",
+ "createdAt" : "2023-11-24T23:41:58.783377"
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Id |
+
|
+
|
+Name |
+
|
+
|
+Age |
+
|
+
|
+Hobby |
+
|
+
|
+Creation Datetime |
+
포스트
+
+
+
+
+
++
+
+포스트 다건 페이지 조회
+
+
+
+
+
+GET /posts
+
+
+
+
+| + + | ++포스트가 없을 경우 + | +
+
+
+Request
+
+
+
+
+GET /api/v1/posts HTTP/1.1
+Host: localhost:8080
+
+Request
+
+
+
+
+GET /api/v1/posts?page=3&size=10 HTTP/1.1
+Host: localhost:8080
+
+
+
+Response
+
+
+
+
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 1260
+
+{
+ "isEmpty" : false,
+ "totalPages" : 4,
+ "totalElements" : 35,
+ "content" : [ {
+ "id" : 1,
+ "title" : "To Your Scattered Bodies Go",
+ "content" : "And it must follow, as the night the day, thou canst not then be false to any man.",
+ "authorName" : "Garnet",
+ "createdAt" : "2023-11-24T23:41:58.153386"
+ }, {
+ "id" : 2,
+ "title" : "The Grapes of Wrath",
+ "content" : "This above all: to thine own self be true.",
+ "authorName" : "Bernardo",
+ "createdAt" : "2023-11-24T23:41:58.15365"
+ }, {
+ "id" : 3,
+ "title" : "A Catskill Eagle",
+ "content" : "Doubt that the sun doth move, doubt truth to be a liar, but never doubt I love.",
+ "authorName" : "Graciela",
+ "createdAt" : "2023-11-24T23:41:58.153812"
+ }, {
+ "id" : 4,
+ "title" : "Dying of the Light",
+ "content" : "Neither a borrower nor a lender be; For loan oft loses both itself and friend, and borrowing dulls the edge of husbandry.",
+ "authorName" : "Winfred",
+ "createdAt" : "2023-11-24T23:41:58.153974"
+ }, {
+ "id" : 5,
+ "title" : "An Evil Cradling",
+ "content" : "Doubt that the sun doth move, doubt truth to be a liar, but never doubt I love.",
+ "authorName" : "Ula",
+ "createdAt" : "2023-11-24T23:41:58.154138"
+ } ]
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+True if no post is found |
+
|
+
|
+Total number of pages |
+
|
+
|
+Total number of all posts |
+
|
+
|
+Post Id |
+
|
+
|
+Title |
+
|
+
|
+Content |
+
|
+
|
+Author Name |
+
|
+
|
+Creation Datetime |
+
+
+포스트 생성
+
+
+
+
+
+POST /posts
+
+
+
+
+| + + | ++포스트 생성 성공 + | +
+
+
+
+Request
+
+
+
+
+POST /api/v1/posts HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 95
+Host: localhost:8080
+
+{
+ "title" : "To a God Unknown",
+ "content" : "Brevity is the soul of wit.",
+ "userId" : 1
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Title |
+
|
+
|
+Content |
+
|
+
|
+User ID |
+
+
+
+
+Response
+
+
+
+
+HTTP/1.1 201 Created
+Content-Type: application/json
+Content-Length: 167
+
+{
+ "id" : 2,
+ "title" : "To a God Unknown",
+ "content" : "Brevity is the soul of wit.",
+ "authorName" : "Jeannetta",
+ "createdAt" : "2023-11-24T23:41:58.249385"
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+ID |
+
|
+
|
+Title |
+
|
+
|
+Content |
+
|
+
|
+Author Name |
+
|
+
|
+Creation Datetime |
+
+
+
+
+| + + | ++존재하지 않는 유저의 포스트를 생성하는 경우 + | +
+
+Request
+
+
+
+
+POST /api/v1/posts HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 117
+Host: localhost:8080
+
+{
+ "title" : "Ring of Bright Water",
+ "content" : "Rich gifts wax poor when givers prove unkind.",
+ "userId" : 2
+}
+
+
+
+Response
+
+
+
+
+HTTP/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 57
+
+{
+ "message" : "존재하지 않는 유저 입니다."
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Error Message |
+
+
+포스트 단건 조회
+
+
+
+
+
+GET /posts/{id}
+
+
+
+
+| + + | ++포스트 상세 정보 조회 성공 + | +
+
+Request
+
+
+
+
+GET /api/v1/posts/3 HTTP/1.1
+Host: localhost:8080
+
+
+
+Response
+
+
+
+
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 216
+
+{
+ "id" : 3,
+ "title" : "An Evil Cradling",
+ "content" : "Now is the winter of our discontent.",
+ "authorName" : "Pia",
+ "createdAt" : "2023-11-24T23:41:58.301576",
+ "updatedAt" : "2023-11-24T23:41:58.301595"
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+ID |
+
|
+
|
+Title |
+
|
+
|
+Content |
+
|
+
|
+Author Name |
+
|
+
|
+Creation Datetime |
+
|
+
|
+Last Update Datetime |
+
+
+
+
+| + + | ++포스트가 존재하지 않는 경우 + | +
+
+Request
+
+
+
+
+GET /api/v1/posts/2 HTTP/1.1
+Host: localhost:8080
+
+
+
+Response
+
+
+
+
+HTTP/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 60
+
+{
+ "message" : "존재하지 않는 게시글 입니다."
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Error Message |
+
+
+포스트 수정
+
+
+
+
+
+PUT /posts/{id}
+
+
+
+
+| + + | ++포스트 정보 수정 성공 + | +
+
+
+
+Request
+
+
+
+
+PUT /api/v1/posts/8 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 91
+Host: localhost:8080
+
+{
+ "title" : "Mr Standfast",
+ "content" : "A little more than kin, and less than kind."
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Title |
+
|
+
|
+Content |
+
+
+
+
+Response
+
+
+
+
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 225
+
+{
+ "id" : 8,
+ "title" : "Mr Standfast",
+ "content" : "A little more than kin, and less than kind.",
+ "authorName" : "Granville",
+ "createdAt" : "2023-11-24T23:41:58.374937",
+ "updatedAt" : "2023-11-24T23:41:58.374968"
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+ID |
+
|
+
|
+Title |
+
|
+
|
+Content |
+
|
+
|
+Author Name |
+
|
+
|
+Creation Datetime |
+
|
+
|
+Last Update Datetime |
+
+
+
+
+| + + | ++포스트가 존재하지 않는 경우 + | +
+
+Request
+
+
+
+
+PUT /api/v1/posts/3 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 296
+Host: localhost:8080
+
+{
+ "title" : "The Heart Is a Lonely Hunter",
+ "content" : "What a piece of work is man! how noble in reason! how infinite in faculty! in form and moving how express and admirable! in action how like an angel! in apprehension how like a god! the beauty of the world, the paragon of animals! ."
+}
+
+
+
+Response
+
+
+
+
+HTTP/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 60
+
+{
+ "message" : "존재하지 않는 게시글 입니다."
+}| Path | +Type | +Description | +
|---|---|---|
|
+
|
+Error Message |
+