API 구상하기

블로그엔 어떤 기능이 필요할까?

• 기능 분석을 먼저 해야 어떤 API가 필요할지 구상할 수 있어요!
• 여러분에게 익숙한 블로그라는 서비스는 기본적으로 어떤 기능이 필요할지 한번 고민해봐요!
  ex) 게시글 작성, 게시글 삭제, ...

각 기능에 대한 API 구상

• 이제 구현하기로 마음 먹은 기능들의 API를 어떤 HTTP Method로 작성할지, 주소는 어떻게 할지 고민하며 작성해보세요.
• 작성하는 양식은 아래와 같습니다. 데이터 표현식은 jsdoc을 따릅니다.

1. 기본적인 요청/응답 인터페이스 예시

Request
- Method: GET
- URL: /articles
Response
- HTTP Status Code: 200
- Payload: { articleId: number, content: string, authorId: number }[]

2. Body를 가진 (POST, PUT, DELETE, ... 등의 Method)를 가진 인터페이스 예시

Request
- Method: POST
- URL: /articles
- Body: { content: string, authorId: number }
Response
- HTTP Status Code: 201
- Payload: { articleId: number }

3. URL에 Params가 있는 API 예시

Request
- Method: PUT
- URL: /articles/:articleId
- Body: { content: string }
Response
- HTTP Status Code: 200
- Payload: { articleId: number, content: string, authorId: number }