From 1e06c1ad50b441a3a4e82f712efaa0cb7c01499f Mon Sep 17 00:00:00 2001 From: Lucy Oh <56earls@gmail.com> Date: Sat, 22 Jun 2024 03:41:32 +0900 Subject: [PATCH] Docs: Update README.md --- .github/workflows/build-deploy.yml | 10 +- .../static/docs/experience-community.html | 824 ------------------ .../src/main/resources/static/docs/index.html | 524 ----------- .../src/main/resources/static/docs/post.html | 527 ----------- 4 files changed, 5 insertions(+), 1880 deletions(-) delete mode 100644 unibond/src/main/resources/static/docs/experience-community.html delete mode 100644 unibond/src/main/resources/static/docs/index.html delete mode 100644 unibond/src/main/resources/static/docs/post.html diff --git a/.github/workflows/build-deploy.yml b/.github/workflows/build-deploy.yml index d3a5956..8ef83b2 100644 --- a/.github/workflows/build-deploy.yml +++ b/.github/workflows/build-deploy.yml @@ -1,10 +1,10 @@ name: Build and Deploy Spring Boot to AWS EC2 -on: - push: - branches: ["main"] - pull_request: - branches: ["main"] +# on: +# push: +# branches: ["main"] +# pull_request: +# branches: ["main"] env: PROJECT_NAME: unibond diff --git a/unibond/src/main/resources/static/docs/experience-community.html b/unibond/src/main/resources/static/docs/experience-community.html deleted file mode 100644 index 0519c7d..0000000 --- a/unibond/src/main/resources/static/docs/experience-community.html +++ /dev/null @@ -1,824 +0,0 @@ - - - - - - - - -Experience Community API - - - - - - -
-
-

Get Experience Community Posts

-
-
-

경험 기록 게시판 내용 가져오기

-
-
-

Request

-
-
-
GET /api/v1/community/experience HTTP/1.1
-Content-Type: application/json;charset=UTF-8
-Host: localhost:8080
-
-
-
-
-

Response

-
-
-
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-Content-Length: 2708
-
-{
-  "isSuccess" : true,
-  "code" : 1000,
-  "message" : "요청에 성공하였습니다.",
-  "result" : {
-    "numberOfElements" : 7,
-    "postPreviewList" : [ {
-      "createdDate" : "2023-12-27T03:16:53.252948",
-      "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/KakaoTalk_20230528_222457241_05.png",
-      "ownerNick" : "5jizzi",
-      "disease" : "13번 염색체 장완 21-22 부분의 결손",
-      "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-12-26T04:09:10.8631",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-12-26T04:09:05.784257",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-12-26T04:02:22.167476",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-12-26T03:43:15.496574",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-11-16T14:18:33.129163",
-      "ownerProfileImg" : "http://testimg3",
-      "ownerNick" : "jiwoon",
-      "disease" : "뇌하수체-의존 부신피질기능항진증",
-      "contentPreview" : "create post test by jiwon",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-11-16T13:55:27.91433",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "create post test by jisoo",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    } ],
-    "lastPage" : true,
-    "totalPages" : 1,
-    "totalElements" : 7,
-    "size" : 30
-  }
-}
-
-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PathTypeDescription

isSuccess

Boolean

성공 여부

code

Number

결과 코드

message

String

결과 메세지

result

Object

결과 데이터

result.numberOfElements

Number

반환된 게시글 수

result.postPreviewList

Array

게시글 리스트

result.postPreviewList[].createdDate

String

게시글 작성 일자

result.postPreviewList[].ownerProfileImg

String

게시글 작성자 프로필 사진

result.postPreviewList[].ownerNick

String

게시글 작성자 닉네임

result.postPreviewList[].disease

String

게시글 작성자의 질병

result.postPreviewList[].contentPreview

String

게시글 미리보기

result.postPreviewList[].boardType

String

게시글 종류

result.postPreviewList[].isEnd

Boolean

미리보기로 제공된 게시글의 내용이 마지막인지 여부

result.lastPage

Boolean

현재 마지막 페이지인지 여부

result.totalPages

Number

총 페이지 수

result.totalElements

Number

총 원소 개수

result.size

Number

현재 페이지 사이즈

-
-
-
-
-

Upload Posts on Experience Community

-
-
-

경험 기록 게시판에 게시물 업로드하기

-
-
-

Request

-
-
-
$ http --multipart POST 'http://localhost:8080/api/v1/community/experience' \
-    'Authorization:29' \
-    'postImg'@'test-img.jpg' \
-    'request'@'request'
-
-
-
-
-
$ curl 'http://localhost:8080/api/v1/community/experience' -i -X POST \
-    -H 'Content-Type: multipart/form-data;charset=UTF-8' \
-    -H 'Authorization: 29' \
-    -F 'postImg=@test-img.jpg;type=multipart/form-data' \
-    -F 'request=@request;type=application/json'
-
-
- ---- - - - - - - - - - - - - -
NameDescription

Authorization

Basic auth credentials

- ---- - - - - - - - - - - - - - - - - -
PartDescription

postImg

업로드 할 게시물 사진 파일

request

게시물 업로드 요청

- ----- - - - - - - - - - - - - - - -
PathTypeDescription

content

String

[request.content] 업로드 할 게시물 내용

-
-
    -
  • -

    request의 경우 다음과 같은 예시처럼 json 타입으로 전달합니다.

    -
    • -
-
-
-
-
{
-  "content" : "게시물 업로드 테스트 입니다."
-}
-
-
-
-
-

Response

-
-
-
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-Content-Length: 95
-
-{
-  "isSuccess" : true,
-  "code" : 1000,
-  "message" : "요청에 성공하였습니다."
-}
-
-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
PathTypeDescription

isSuccess

Boolean

성공 여부

code

Number

결과 코드

message

String

결과 메세지

-
-
-
-
- - - \ No newline at end of file diff --git a/unibond/src/main/resources/static/docs/index.html b/unibond/src/main/resources/static/docs/index.html deleted file mode 100644 index f62057f..0000000 --- a/unibond/src/main/resources/static/docs/index.html +++ /dev/null @@ -1,524 +0,0 @@ - - - - - - - - -UniBond API Document - - - - - - -
-
-

Http Status Code

-
- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Status codeUsage

200 OK

The request completed successfully

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s -Location header

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

404 Not Found

The requested resource did not exist

-
-
-
-

API List

-
-
-

Community

-
- -
-
-
-
-
- - - \ No newline at end of file diff --git a/unibond/src/main/resources/static/docs/post.html b/unibond/src/main/resources/static/docs/post.html deleted file mode 100644 index 4fea967..0000000 --- a/unibond/src/main/resources/static/docs/post.html +++ /dev/null @@ -1,527 +0,0 @@ - - - - - - - - -Post API - - - - - - -
-
-

Get Experience Community Posts

-
-
-

경험 기록 게시판 내용 가져오기

-
-
-

Request

-
-
-
GET /api/v1/community/experience HTTP/1.1
-Content-Type: application/json;charset=UTF-8
-Host: localhost:8080
-
-
-
-
-

Response

-
-
-
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-Content-Length: 902
-
-{
-  "isSuccess" : true,
-  "code" : 1000,
-  "message" : "요청에 성공하였습니다.",
-  "result" : {
-    "numberOfElements" : 2,
-    "postPreviewList" : [ {
-      "createdDate" : "2023-11-16T14:18:33.129163",
-      "ownerProfileImg" : "http://testimg3",
-      "ownerNick" : "jiwoon",
-      "disease" : "뇌하수체-의존 부신피질기능항진증",
-      "contentPreview" : "create post test by jiwon",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    }, {
-      "createdDate" : "2023-11-16T13:55:27.91433",
-      "ownerProfileImg" : "http://testimg1",
-      "ownerNick" : "jisoo2",
-      "disease" : "5번 염색체 장완의 결손 증후군",
-      "contentPreview" : "create post test by jisoo",
-      "boardType" : "EXPERIENCE",
-      "isEnd" : true
-    } ],
-    "lastPage" : true,
-    "totalPages" : 1,
-    "totalElements" : 2,
-    "size" : 30
-  }
-}
-
-
-
-
-
-
- - - \ No newline at end of file