https://github.com/yamoo9/post-api-server

rest-api-test

Last synced: 10 months ago
JSON representation

Express 앱 배포 (with render.com)

README

# Post API 서버

## 포스트 리스트 읽기

포스트 리스트를 응답합니다.

```sh
GET /api/v1/posts
```

## 포스트 검색

포스트를 검색하여 응답합니다.

### 작성자 쿼리

요청한 작성자 이름으로 포스트를 검색하여 응답합니다.

```sh
GET /api/v1/posts?author={author-name}
```

### 검색어 쿼리

요청한 포스트 본문 내용을 검색하여 응답합니다.

```sh
GET /api/v1/posts?q={search}
```

### 페이지네이션 쿼리

요청한 페이지 번호 또는 페이지 갯수에 맞춰 포스트를 검색하여 응답합니다.

```sh
GET /api/v1/posts?page=2&perPage=3
```

## 포스트 읽기

요청한 아이디 속성 값과 일치하는 포스트를 응답합니다.

```sh
GET /api/v1/posts/:id
```

## 포스트 쓰기

새로운 포스트를 생성한 뒤 응답합니다.

```sh
POST /api/v1/posts
```

## 포스트 수정

요청한 아이디 속성 값과 일치하는 포스트 수정한 뒤 응답합니다.

```sh
PUT /api/v1/posts/:id
```

## 포스트 삭제

요청한 아이디 속성 값과 일치하는 포스트 삭제한 뒤 응답합니다.

```sh
DELETE /api/v1/posts/:id
```

## 포스트 초기화

포스트 리스트를 초기화합니다.

```sh
DELETE /api/v1/posts/reset
```