게시판 API - TeamCrazyPerformance/tcp-api GitHub Wiki

URI

Method URI feat
GET /api/articles 게시판 글 목록 조회
GET /api/articles?category="study" 특정 카테고리 게시글 목록 조회
GET /api/articles/:articleId 특정 게시글 조회
POST /api/articles 게시글 작성
PATCH /api/articles/:articleId 게시글 수정
DELETE /api/articles/:articleId 게시글 삭제
PATCH /api/articles/:articleId 공지글 반영
POST /api/articles/:articleId/comment 댓글 작성
PATCH /api/articles/:articleId/comments/:commentId 댓글 수정
DELETE /api/articles/:articleId/comments/:commentId 댓글 삭제
GET /api/articles?users="[email protected]" 내가 쓴 게시글 목록 조회

특정 게시글 조회

URI

 GET   /api/articles/:articleId 

Response

200 : Ok
{
    "article": {
        "id": "number",
        "author": {
            "id": "string",
            "github": "string",
            "username": "string",
            "avatar": "string"
        },
        "title": "string",
        "contents": "string",
        "commentCount": "number",
        "viewCount": "number",
        "createdAt": "Date",
        "updatedAt": "Date"
    }
}

401 : Unauthorized
{}
404 : NotFound
{}