From cdd8fbd8dfd7521fe61f987e16dbcf209a58c0d0 Mon Sep 17 00:00:00 2001 From: 5jisoo <56earls@gmail.com> Date: Sun, 31 Dec 2023 04:59:50 +0900 Subject: [PATCH] =?UTF-8?q?Chore:=20API=20docs=20html=20=EC=97=85=EB=8D=B0?= =?UTF-8?q?=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../BOOT-INF/classes/static/docs/disease.html | 2 +- .../classes/static/docs/letter-rooms.html | 185 +++++++++++++++++- .../BOOT-INF/classes/static/docs/member.html | 2 +- .../main/resources/static/docs/disease.html | 6 +- .../src/main/resources/static/docs/index.html | 2 +- .../resources/static/docs/letter-rooms.html | 42 +++- .../main/resources/static/docs/member.html | 2 +- 7 files changed, 229 insertions(+), 12 deletions(-) diff --git a/unibond/BOOT-INF/classes/static/docs/disease.html b/unibond/BOOT-INF/classes/static/docs/disease.html index be7a6c6..05342c2 100644 --- a/unibond/BOOT-INF/classes/static/docs/disease.html +++ b/unibond/BOOT-INF/classes/static/docs/disease.html @@ -470,7 +470,7 @@

Request

GET /api/v1/diseases/search?lan=kor&query=8%EB%B2%88+%EC%97%BC%EC%83%89%EC%B2%B4&page=0 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
-Host: docs.api.com:8080
+Host: localhost:8080
diff --git a/unibond/BOOT-INF/classes/static/docs/letter-rooms.html b/unibond/BOOT-INF/classes/static/docs/letter-rooms.html index 83f6f86..45afc16 100644 --- a/unibond/BOOT-INF/classes/static/docs/letter-rooms.html +++ b/unibond/BOOT-INF/classes/static/docs/letter-rooms.html @@ -454,6 +454,12 @@

Member API

  • Response
    • +
  • Get All Letters in Letter Rooms + +
    • @@ -471,7 +477,7 @@

    Request

    GET /api/v1/letter-rooms?page=0 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Authorization: 3
-Host: docs.api.com:8080
    +Host: localhost:8080
    @@ -623,11 +629,186 @@

    Response

    +
    +

    Get All Letters in Letter Rooms

    +
    +
    +

    참여 중인 편지방 내부의 편지들 가져오기

    +
    +
    +

    Request

    +
    +
    +
    GET /api/v1/letter-rooms/9?page=0 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: 2
+Host: localhost:8080
    +
    +
    +
    ++++ + + + + + + + + + + + + +
    ParameterDescription

    page

    조회할 페이지 [default: 0]

    + +
    +

    Response

    +
    +
    +
    HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 725
+
+{
+  "isSuccess" : true,
+  "code" : 1000,
+  "message" : "요청에 성공하였습니다.",
+  "result" : {
+    "receiverProfileImg" : "http://testimg2",
+    "receiverName" : "jiny",
+    "receiverDiseaseName" : "7번 염색체 장완 36 부분의 미세결손 증후군",
+    "receiverDiagnosisTiming" : "2013-11-10",
+    "pageInfo" : {
+      "lastPage" : true,
+      "totalPages" : 1,
+      "totalElements" : 2,
+      "size" : 30
+    },
+    "letterList" : [ {
+      "senderName" : "jiny",
+      "sentDate" : "2023-11-11T00:46:29.911363",
+      "letterTitle" : "title 2"
+    }, {
+      "senderName" : "lucy",
+      "sentDate" : "2023-11-11T00:46:24.69997",
+      "letterTitle" : "title 1"
+    } ]
+  }
+}
    +
    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PathTypeDescription

    isSuccess

    Boolean

    성공 여부

    code

    Number

    결과 코드

    message

    String

    결과 메세지

    result

    Object

    결과 데이터

    result.receiverProfileImg

    String

    수신자 프로필 이미지

    result.receiverName

    String

    수신자 이름

    result.receiverDiseaseName

    String

    수신자 질병 이름

    result.receiverDiagnosisTiming

    String

    수신자 진단 시기

    result.pageInfo

    Object

    페이징 정보

    result.pageInfo.lastPage

    Boolean

    페이징 정보: 마지막 페이지인지의 여부

    result.pageInfo.totalPages

    Number

    페이징 정보: 총 페이지 수

    result.pageInfo.totalElements

    Number

    페이징 정보: 총 검색 결과 개수

    result.pageInfo.size

    Number

    페이징 정보: 현재 페이지의 크기 [default: 30] - size는 parameter를 통해 전송하지 않는 것을 추천드립니다.

    result.letterList

    Array

    편지 리스트

    result.letterList[].senderName

    String

    편지 리스트: 송신자 이름

    result.letterList[].sentDate

    String

    편지 리스트: 편지 송신 시각

    result.letterList[].letterTitle

    String

    편지 리스트: 편지 제목

    +
    + + diff --git a/unibond/BOOT-INF/classes/static/docs/member.html b/unibond/BOOT-INF/classes/static/docs/member.html index 5ec1de0..7928c9e 100644 --- a/unibond/BOOT-INF/classes/static/docs/member.html +++ b/unibond/BOOT-INF/classes/static/docs/member.html @@ -615,7 +615,7 @@

    Response

    "code" : 1000, "message" : "요청에 성공하였습니다.", "result" : { - "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/5ee7f42a-219f-4d27-8978-cb6d1b8186edtest_profile_img.jpg", + "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/ec2cb752-c710-47b9-a01b-0b5c9ea7357atest_profile_img.jpg", "nickname" : "5jizzi", "gender" : "MALE", "diseaseName" : "1번 염색체 장완 21.3 부분의 미세결손 증후군", diff --git a/unibond/src/main/resources/static/docs/disease.html b/unibond/src/main/resources/static/docs/disease.html index 05342c2..e748a06 100644 --- a/unibond/src/main/resources/static/docs/disease.html +++ b/unibond/src/main/resources/static/docs/disease.html @@ -6,7 +6,7 @@ -Member API +Disease API