MOAMOA API details

모아모아 API 명세서

공지사항

생성

HTTP request

POST /api/studies/{study-id}/notice/articles
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX


{
  "title" : "공지사항 글 제목",
  "content" : "공지사항 글 내용"
}

HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/studies/{study-id}/notice/articles/{article-id}
Content-Type: application/json
Content-Length: 47
Access-Control-Allow-Headers: Location

단건 조회

HTTP request

GET /api/studies/{study-id}/notice/articles/{article-id}
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

{
  "id" : 1,
  "author" : {
    "id" : 2,
    "username" : "jaejae-yoo",
    "imageUrl" : "images/123",
    "profileUrl" : "https://github.com/user/jaejae-yoo"
  },
  "title" : "공지사항 글 제목",
  "content" : "공지사항 글 내용",
  "createdDate" : 2022-08-09,
  "lastModifiedDate" : 2022-08-09
}

목록 조회

HTTP request

GET /api/studies/{study-id}/notice/articles?page=0&size=5
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

{
  "articles" : [{
    "id" : 1,
    "author" : {
      "id" : 2,
      "username" : "jaejae-yoo",
      "imageUrl" : "images/123",
      "profileUrl" : "https://github.com/user/jaejae-yoo"
    },
    "title" : "커뮤니티 글 제목",
    "createdDate" : 2022-08-09,
    "lastModifiedDate" : 2022-08-09,
  }
  ...
  ],
  "currentPage" : 0,
  "lastPage" : 5,
  "totalCount" : 100
}

수정

HTTP request

PUT /api/studies/{study-id}/notice/articles/{article-id}
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

{
  "title" : "공지사항 글 제목",
  "content" : "공지사항 글 내용"
}

HTTP response

HTTP/1.1 204 No content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

삭제

HTTP request

DELETE /api/studies/{study-id}/notice/articles/{article-id}
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 204 No content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

---

커뮤니티 게시글 임시 저장

생성

POST /api/studies/{study-id}/community/draft-articles
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

{
  "title" : "게시글 제목",
  "content" : "게시글 내용"
}

HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47
Location: /api/studies/{study-id}/community/draft-articles/23

{
   "draftArticleId": 23
}

---

수정

HTTP request

PUT /api/studies/{study-id}/community/draft-articles/23
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

{
  "title" : "게시글 제목",
  "content" : "게시글 내용"
}

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

---

커뮤니티 임시저장 게시글 전체 목록 조회

HTTP request

GET /api/draft/community/articles
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

{
  "draftArticles" : [ {
    "id" : 5,
    "title" : "자바 게시글 제목4",
    "createdDate" : "2022-09-02",
    "lastModifiedDate" : "2022-09-02",
    "study": {
      "id": 1,
      "title": "자바 스터디"
    },
  }, {
    "id" : 4,
    "title" : "자바 게시글 제목3",
    "createdDate" : "2022-09-02",
    "lastModifiedDate" : "2022-09-02",
    "study": {
      "id": 1,
      "title": "자바 스터디"
    },
  }, {
    "id" : 3,
    "title" : "자바 게시글 제목2",
    "createdDate" : "2022-09-02",
    "lastModifiedDate" : "2022-09-02",
    "study": {
      "id": 2,
      "title": "자바 스터디2"
    },
  } ],
  "currentPage" : 0,
  "lastPage" : 1,
  "totalCount" : 4
}

---

임시 저장 단건 조회

HTTP request

GET /api/studies/{study-id}/community/draft-articles/{draft-article-id}
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

{
  "id" : 5,
  "title" : "자바 게시글 제목",
  "content" : "자바 게시글 내용"
  "createdDate" : "2022-09-02",
  "lastModifiedDate" : "2022-09-02"
}

---

삭제

HTTP request

DELETE /api/studies/{study-id}/community/draft-articles/23
Content-Type: application/json
Accept: application/json
Content-Length: 35
Host: localhost:8080
Authorization: Bearer XXXXXXXX

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 47

---