Skip to content

To-do API specification 설계하기 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

To-do API specification 설계하기 #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1910350
Update openapi.yaml
ramyo564 Oct 11, 2024
eb7cdf0
patch 부분 summary 수정
ramyo564 Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
213 changes: 210 additions & 3 deletions todo-app/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
openapi: 3.0.3
info:
title: To-do service API
title: Extreme To-do service API
description: |-
간단한 할 일 관리 서비스의 API
todo list에 할 일을 쌓아두기만? -> X <br>
하루에 중요한 할 일 <b>딱 10개만</b> 관리하는 todo list! <br>
<br>
지금 해야 할 일이 이미 10개 이상인가요? <br>
그럼 그중에서도 <b>가장 급한 일 10개부터 끝내고 생각하세요!</b>

version: 1.0.0
servers:
- url: http://localhost:8080
Expand All @@ -14,7 +19,7 @@ paths:
get:
tags:
- API
summary: Health cehck
summary: Health check
description: |
API 서버가 잘 작동하는지 확인하는 용도의 API.
responses:
Expand All @@ -37,6 +42,7 @@ paths:
properties:
tasks:
type: array
description: 할 일 목록 배열
items:
type: object
properties:
Expand All @@ -48,7 +54,208 @@ paths:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 1강부터 3강까지 공부해야함
createdAt:
type: string
description: 할 일 등록 일시 (UTC)
example: "2024-10-01 12:34:56"
example:
tasks:
- id: "01BX5ZZKBKACTAV9WEVGEMMVRY"
title: "과제하기"
contents: "1강부터 3강까지 공부해야함"
createdAt: "2024-10-01 12:34:56"
- id: "01BX5ZZKBKACTAV9WEVGEMMVZZ"
title: "알고리즘 공부하기"
contents: "3시까지 정렬, 해시맵 공부"
createdAt: "2024-10-02 14:22:00"

post:
tags:
- API
summary: Create a task
description: |
할 일 목록을 만들기
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "1강부터 3강까지 공부해야함"
responses:
'200':
description: 할 일을 성공적으로 생성함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 1강부터 3강까지 공부해야함
createdAt:
type: string
description: 할 일 등록 일시 (UTC)
example: "2024-10-01 12:34:56"

put:
tags:
- API
summary: Update a task
description: |
할 일 수정하기 (전체 업데이트)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "4강부터 5강까지 공부해야함"
responses:
'200':
description: 할 일을 성공적으로 업데이트함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 5강부터 10강까지 공부해야함
updatedAt:
type: string
description: 할 일 수정 일시 (UTC)
example: "2024-10-02 12:34:56"
/tasks/{taskId}:
patch:
tags:
- API
summary: Finish a task
description: |
할 일 수정하기 (부분 업데이트)
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task의 식별자
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "5강부터 10강까지 공부해야함"
taskDone:
type: boolean
description: 할 일이 완료되었는지 여부
example: true
responses:
'200':
description: 할 일을 성공적으로 수정함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 5강부터 10강까지 공부해야함
taskDone:
type: boolean
description: 할 일이 완료되었는지 여부
example: true
updatedAt:
type: string
description: 할 일 수정 일시 (UTC)
example: "2024-10-02 12:34:56"

delete:
tags:
- API
summary: Delete a task
description: |
할 일 삭제하기
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task의 식별자
responses:
'200':
description: 할 일을 성공적으로 삭제함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
deletedAt:
type: string
description: 할 일 삭제 일시 (UTC)
example: "2024-10-02 12:34:56"
isDeleted:
type: boolean
description: 삭제 여부
example: true