# 코드잇 실습용 서버 호스트 코드잇 실습용 서버 호스트입니다. ``` learn.codeit.kr ``` # 유저 데이터 (User) 유저와 관련된 API 엔드포인트입니다. # 유저 조회 특정 유저의 정보를 조회합니다. ## 엔드포인트 ``` GET /api/codestudit/users/ ``` ## 파라미터 **username: string (필수)** 조회할 유저의 닉네임 ## 리턴 내용 - 성공 시 상태 코드 200과 함께 유저 데이터가 제공됩니다. - 실패 시 상태 코드 404가 반환됩니다. ## 리퀘스트 예시 ```plaintext GET https://learn.codeit.kr/api/codestudit/users/codeit ``` ## 리스폰스 예시 ```json { "id": 1, "username": "codeit", "name": "코드잇", "createdAt": 1697180528, "updatedAt": 1697180700 } ``` # 포스트(Post) ## 엔드포인트 ```plaintext GET /api/codestudit/posts GET /api/codestudit/posts?username= ``` # 모든 포스트 조회 모든 포스트를 조회합니다. ## 엔드포인트 ``` GET /api/codestudit/posts ``` ## 쿼리 파라미터 **page: number (기본값: 0)** 조회할 페이지 번호 **limit: number (기본값: 10)** 한 페이지당 포스트 수 **username: string** 특정 유저의 포스트만 조회할 경우 사용 ## 리턴 내용 성공 시 상태 코드 200과 함께 포스트 목록, 총 포스트 수, 페이지 정보가 반환됩니다. ## 리퀘스트 예시 ```plaintext GET https://learn.codeit.kr/api/codestudit/posts?page=1&limit=20&username=helloworld ``` ## 리스폰스 예시 ```json { "results": [ { "id": 1, "content": "야호!", "user": { "id": 123, "username": "helloworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702450928, "updatedAt": 1702450928 }, // ... (다른 포스트들) ], "count": 42, "hasMore": true, "currentPage": 1 } ``` # 포스트 작성 새로운 포스트를 작성합니다. ## 엔드포인트 ``` POST /api/codestudit/posts ``` ## 바디 파라미터 **username: string (필수)** 포스트를 작성하는 유저의 닉네임 **content: string (필수)** 포스트 내용 ## 리턴 내용 - 성공 시 상태 코드 201과 함께 작성된 포스트가 반환됩니다. ## 리퀘스트 예시 ```plaintext POST https://learn.codeit.kr/api/codestudit/posts Content-Type: application/json { "username": "helloworld", "content": "안녕하세요!" } ``` ## 리스폰스 예시 ```json { "id": 101, "content": "안녕하세요!", "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702450928, "updatedAt": 1702450928 } ``` # 댓글 포스트에 대한 댓글과 관련된 API 엔드포인트입니다. ## 엔드포인트 ```plaintext GET /api/codestudit/posts//comments POST /api/codestudit/posts//comments ``` # 모든 댓글 조회 특정 포스트에 대한 모든 댓글을 조회합니다. ## 엔드포인트 ``` GET /api/codestudit/posts//comments ``` ## 파라미터 **postId: number (필수)** 조회할 포스트의 ID ## 쿼리 파라미터 **page: number (기본값: 0)** 조회할 페이지 번호 **limit: number (기본값: 10)** 한 페이지당 댓글 수 ## 리턴 내용 성공 시 상태 코드 200과 함께 댓글 목록, 총 댓글 수, 페이지 정보가 반환됩니다. ## 리퀘스트 예시 ```plaintext GET https://learn.codeit.kr/api/codestudit/posts/101/comments?page=1&limit=20 ``` ## 리스폰스 예시 ```json { "results": [ { "id": 201, "postId": 101, "content": "글 잘 봤습니다.", "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": "2023-01-01T12:34:56Z", "updatedAt": "2023-01-01T12:34:56Z" }, // ... (다른 댓글들) ], "count": 50, "hasMore": true, "currentPage": 1 } ``` # 댓글 작성 특정 포스트에 댓글을 작성합니다. ## 엔드포인트 ``` POST /api/codestudit/posts//comments ``` ## 바디 파라미터 **username: string (필수)** 댓글을 작성하는 유저의 닉네임 **content: string (필수)** 댓글 내용 ## 리턴 내용 성공 시 상태 코드 201과 함께 작성된 댓글이 반환됩니다. ## 리퀘스트 예시 ```plaintext POST https://learn.codeit.kr/api/codestudit/posts/101/comments Content-Type: application/json { "username": "helloworld", "content": "글 잘 봤습니다." } ``` ## 리스폰스 예시 ```json { "id": 251, "postId": 101, "content": "글 잘 봤습니다.", "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702451632, "updatedAt": 1702451632 } ``` # 좋아요 포스트에 대한 좋아요와 관련된 API 엔드포인트입니다. ## 엔드포인트 ``` GET /api/codestudit/posts//likes GET /api/codestudit/posts//likes/ POST /api/codestudit/posts//likes/ DELETE /api/codestudit/posts//likes/ ``` # 모든 좋아요 조회 특정 포스트에 대한 모든 좋아요를 조회합니다. ## 엔드포인트 ``` GET /api/codestudit/posts//likes ``` ## 파라미터 **postId: number (필수)** 조회할 포스트의 ID ## 쿼리 파라미터 **page: number (기본값: 0)** 조회할 페이지 번호 **limit: number (기본값: 10)** 한 페이지당 좋아요 수 ## 리턴 내용 성공 시 상태 코드 200과 함께 좋아요 목록, 총 좋아요 수, 페이지 정보가 반환됩니다. ## 리퀘스트 예시 ```plaintext GET https://learn.codeit.kr/api/codestudit/posts/101/likes?page=1&limit=20 ``` ## 리스폰스 예시 ```json { "results": [ { "id": 301, "postId": 101, "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702451666, "updatedAt": 1702451666 }, // ... (다른 좋아요들) ], "count": 30, "hasMore": true, "currentPage": 1 } ``` # 특정 유저의 좋아요 조회 특정 유저가 특정 포스트에 대한 좋아요 여부를 조회합니다. ## 엔드포인트 ``` GET /api/codestudit/posts//likes/ ``` ## 파라미터 **postId: number (필수)** 조회할 포스트의 ID **username: string (필수)** 조회할 유저의 닉네임 ## 리턴 내용 - 성공 시 상태 코드 200과 함께 좋아요 정보가 반환됩니다. - 실패 시 상태 코드 404가 반환됩니다. ## 리퀘스트 예시 ```plaintext GET https://learn.codeit.kr/api/codestudit/posts/101/likes/helloworld ``` ## 리스폰스 예시 ```json { "id": 301, "postId": 101, "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702451666, "updatedAt": 1702451666 } ``` # 좋아요 생성 특정 포스트에 대한 좋아요를 생성합니다. ## 엔드포인트 ``` POST /api/codestudit/posts//likes/ ``` ## 파라미터 **postId: number (필수)** 좋아요를 생성할 포스트의 ID **username: string (필수)** 좋아요를 생성하는 유저의 닉네임 ## 리턴 내용 - 성공 시 상태 코드 201과 함께 생성된 좋아요 정보가 반환됩니다. ## 리퀘스트 예시 ```plaintext POST https://learn.codeit.kr/api/codestudit/posts/101/likes/helloworld ``` ## 리스폰스 예시 ```json { "id": 301, "postId": 101, "user": { "id": 123, "username": "hellworld", "name": "헬로월드", "createdAt": 1697180528, "updatedAt": 1697180700 }, "createdAt": 1702451666, "updatedAt": 1702451666 } ``` # 좋아요 삭제 특정 포스트에 대한 좋아요를 삭제합니다. ## 엔드포인트 ``` DELETE /api/codestudit/posts//likes/ ``` ## 파라미터 **postId: number (필수)** 삭제할 좋아요가 속한 포스트의 ID **username: string (필수)** 삭제할 좋아요를 생성한 유저의 닉네임 ## 리턴 내용 - 성공 시 상태 코드 204가 반환됩니다. - 실패 시 상태 코드 404가 반환됩니다. ## 리퀘스트 예시 ```plaintext DELETE https://learn.codeit.kr/api/codestudit/posts/101/likes/helloworld ``` ## 리스폰스 예시 ```plaintext 204 No Content ```