REST 라우트 개요
이 페이지는 모든 REST 라우트의 목록과 간단한 설명, 그리고 세부 정보 페이지 링크를 제공합니다.
각 라우트 설명을 살펴보기 전에 서버 연동하기를 먼저 읽어보시기를 권장합니다.
정보
빠른 탐색을 위해 아래 두 탭 중 하나를 사용할 수 있습니다:
- 데이터 객체별 라우트 — 어떤 작업에 어떤 라우트를 사용해야 하는지 파악할 수 있습니다
- 메서드별 라우트 — HTTP 메서드별로 라우트를 빠르게 파악하고 서버가 반환하는 내용을 확인할 수 있습니다
- 데이터 객체별 라우트
- 메서드별 라우트
- tasks
- projects
- users
- tags
다음 라우트를 사용하여 태스크 관련 작업을 수행합니다:
| HTTP 메서드 | 라우트 | 설명 |
|---|---|---|
GET | /tasks | 모든 태스크 데이터를 가져와 태스크 객체 배열이 담긴 json 객체를 반환합니다 |
GET | /tasks/projects | 지정된 프로젝트의 모든 태스크 데이터를 가져와 해당 프로젝트의 모든 태스크 객체 배열이 담긴 json 객체를 반환합니다 |
POST | /tasks | 새 태스크를 생성하고 새 태스크의 ID가 포함된 태스크 객체를 반환합니다 |
POST | /clone | 태스크 복사본을 생성하고 클라이언트 태스크 ID와 서버의 복제된 태스크 ID가 담긴 json 객체를 반환합니다 |
PUT | /tasks | 지정된 태스크의 데이터를 업데이트하고 빈 json 객체를 반환합니다 |
PUT | /move | 태스크를 지정된 위치로 이동하고 빈 json 객체를 반환합니다 |
PUT | /sort | 활성 프로젝트의 모든 태스크를 지정된 파라미터로 정렬하고 빈 json 객체를 반환합니다 |
DELETE | /tasks | 태스크 데이터를 삭제하고 빈 json 객체를 반환합니다 |
다음 라우트를 사용하여 프로젝트 관련 작업을 수행합니다:
| HTTP 메서드 | 라우트 | 설명 |
|---|---|---|
GET | /projects | 모든 프로젝트 데이터를 가져와 프로젝트 객체 배열이 담긴 json 객체를 반환합니다 |
POST | /projects | 새 프로젝트를 생성하고 프로젝트 ID가 포함된 프로젝트 객체를 반환합니다 |
PUT | /projects | 프로젝트 데이터를 업데이트하고 빈 json 객체를 반환합니다 |
DELETE | /projects | 프로젝트 데이터를 삭제하고 빈 json 객체를 반환합니다 |
다음 라우트를 사용하여 사용자 관련 작업을 수행합니다:
| HTTP 메서드 | 라우트 | 설명 |
|---|---|---|
GET | /users | 모든 사용자 데이터를 가져와 사용자 객체 배열이 담긴 json 객체를 반환합니다 |
다음 라우트를 사용하여 태그 관련 작업을 수행합니다:
| HTTP 메서드 | 라우트 | 설명 |
|---|---|---|
GET | /tags | 모든 태그 데이터를 가져와 해당 태그 배열이 담긴 json 객체를 반환합니다 |
- GET
- POST
- PUT
- DELETE
| 이름 | 설명 |
|---|---|
| GET /users | 모든 사용자 객체 배열이 담긴 json 객체를 반환합니다 |
| GET /tasks | 모든 태스크 객체 배열이 담긴 json 객체를 반환합니다 |
| GET /projects | 사용 가능한 모든 프로젝트 객체 배열이 담긴 json 객체를 반환합니다 |
| GET /tags | 모든 기본 태그 배열이 담긴 json 객체를 반환합니다 |
| GET /tasks/projects | 지정된 프로젝트의 모든 태스크 객체 배열이 담긴 json 객체를 반환합니다 |
| 이름 | 설명 |
|---|---|
| POST /clone | 클라이언트 태스크 ID와 서버의 복제된 태스크 ID가 담긴 json 객체를 반환합니다. |
| POST /projects | 프로젝트 ID가 포함된 새 프로젝트 객체를 반환합니다 |
| POST /tasks | 새 태스크의 ID가 포함된 새 태스크 객체를 반환합니다 |
| 이름 | 설명 |
|---|---|
| PUT /move | 요청대로 태스크가 성공적으로 이동된 경우 빈 json 객체를 반환합니다 |
| PUT /sort | 요청대로 태스크가 정렬된 경우 빈 json 객체를 반환합니다 |
| PUT /tasks | 요청대로 태스크가 수정된 경우 빈 json 객체를 반환합니다 |
| PUT /projects | 요청대로 프로젝트가 수정된 경우 빈 json 객체를 반환합니다 |
| 이름 | 설명 |
|---|---|
| DELETE /tasks | 태스크가 성공적으로 삭제된 경우 빈 json 객체를 반환합니다 |
| DELETE /projects | 프로젝트가 성공적으로 삭제된 경우 빈 json 객체를 반환합니다 |