Skip to content

README.md

Latest commit

 

History

History
69 lines (52 loc) · 4.12 KB

README.md

File metadata and controls

69 lines (52 loc) · 4.12 KB

Todo App

할일을 작성하고 관리하는 앱

Introduction

할일을 작성하고 관리하는 RESTful API입니다. 기본 CRUD 기능을 포함합니다

Tech Stack

  • Language:
    Java

  • Framework:

    Spring
    Spring Boot
    Lombok

  • Database:
    MySQL

  • Tools:
    Git
    GitHub

Installation

리포지토리 클론:

  git clone https://github.com/Seungmin-J/todo-api.git

Todo API 명세서

1. 일정 생성

Method URL Request Body Response Status
POST /todos json {
"text": "String 할 일",
"name": "String 작성자 이름",
"password": "String 비밀번호",
"createdAt": "LocalDateTime 일정 생성 시간",
"editedAt": "LocalDateTime 일정 수정 시간" }		 TodoResponseDto CREATED : 201
BAD_REQUEST : 400

2. 전체 일정 조회 / 수정일, 작성자명 기준 조회

Method URL Request Param Request Body Response Status
GET /todos name: 작성자명, editedAt: 수정일 - List<TodoResponseDto> OK : 200

3. 선택 일정 조회

Method URL PathVariable Request Body Response Status
GET /todos/{id} id: 조회할 일정의 ID - TodoResponseDto OK : 200
NOT_FOUND : 404

4. 선택 일정, 이름 수정

Method URL PathVariable Request Param Response Status
PUT /todos/{id} id: 수정할 일정의 ID name: 작성자명 text: 할일 TodoResponseDto OK : 200
NOT_FOUND : 404

5. 선택 일정 삭제

Method URL PathVariable Request Body Response Status
DELETE /todos/{id} id: 삭제할 일정의 ID "비밀번호"(text형식) - OK : 200
BAD_REQUEST : 400

ERD

img.png

Contact