Skip to content

[DOCS]카카오 로그인 문서 작성 #14

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

Merged
lsn5963 merged 4 commits into from
Jan 1, 2025
Merged

[DOCS]카카오 로그인 문서 작성 #14

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a0535c
Merge pull request #11 from Move-Log/develop
EunbeenDev Dec 30, 2024
716b69d
Merge pull request #12 from Move-Log/develop
EunbeenDev Dec 30, 2024
593cbb9
Merge pull request #13 from Move-Log/develop
EunbeenDev Dec 30, 2024
d8ad69a
fix/구글로그인
lsn5963 Jan 1, 2025
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
203 changes: 109 additions & 94 deletions src/main/resources/static/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,30 +42,31 @@
"/auth": {
"post": {
"tags": ["Auth"],
"summary": "구글 로그인",
"description": "구글 로그인을 수행합니다.",
"summary": "카카오 로그인",
"description": "카카오 로그인을 수행합니다. ID 토큰과 provider 정보를 전달받아 인증을 처리합니다.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignInReq"
"$ref": "#/components/schemas/IdTokenReq"
}
}
}
},
"responses": {
"200": {
"description": "구글 로그인 성공",
"description": "카카오 로그인 성공",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
"$ref": "#/components/schemas/AuthRes"
}
}
}
},
"400": {
"description": "생성 실패",
"description": "로그인 실패",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -800,105 +801,106 @@
},
"components": {
"schemas": {
"SignInReq": {
"IdTokenReq": {
"type": "object",
"properties": {
"email": {
"idToken": {
"type": "string",
"description": "이메일"
"description": "카카오에서 발급된 ID 토큰"
},
"providerId": {
"provider": {
"type": "string",
"description": "구글 로그인 시 제공되는 providerId"
"description": "'kakao'를 입력해야 합니다.",
"example": "kakao"
}
},
"required": ["token"]
},
"CreateWriteReq": {
"type": "object",
"properties": {
"verbType": {
"type": "integer",
"description": "했어요 0, 먹었어요 1, 갔어요 2",
"example": 0
},
"noun": {
"type": "string",
"description": "명사",
"example": "헬스"
},
"record_image": {
"type": "string",
"description": "기록 이미지",
"example": "#$!~@#!@#!@213123"
}
"required": ["idToken", "provider"]
},
"CreateWriteReq": {
"type": "object",
"properties": {
"verbType": {
"type": "integer",
"description": "했어요 0, 먹었어요 1, 갔어요 2",
"example": 0
},
"noun": {
"type": "string",
"description": "명사",
"example": "헬스"
},
"record_image": {
"type": "string",
"description": "기록 이미지",
"example": "#$!~@#!@#!@213123"
}
},
"RetrieveMyRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "기록 생성 건수",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "최고 연속 기록",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "평균 일간 기록",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "일일 최다 기록",
"example": 2
}
}
},
"RetrieveMyRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "기록 생성 건수",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "최고 연속 기록",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "평균 일간 기록",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "일일 최다 기록",
"example": 2
}
},
"RetrieveMyCalendarRes": {
"properties": {
"myRecordDate": {
"type": "string",
"description": "기록 생성 날짜",
"example": "2024-11-23"
},
"numRecord": {
"type": "integer",
"description": "일자별 기록 개수",
"example": 5
}
}
},
"RetrieveMyCalendarRes": {
"properties": {
"myRecordDate": {
"type": "string",
"description": "기록 생성 날짜",
"example": "2024-11-23"
},
"numRecord": {
"type": "integer",
"description": "일자별 기록 개수",
"example": 5
}
},
"RetrieveAllRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "총 기록 생성 건수",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "최고 연속 기록",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "평균 일간 기록",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "일일 최다 기록",
"example": 2
}
}
},
"RetrieveAllRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "총 기록 생성 건수",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "최고 연속 기록",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "평균 일간 기록",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "일일 최다 기록",
"example": 2
}
},
"RetrieveTotalTop5ListRes": {
"properties": {
"word": {
}
},
"RetrieveTotalTop5ListRes": {
"properties": {
"word": {
"type": "string",
"description": "단어",
"example": "공부"
Expand Down Expand Up @@ -1234,6 +1236,19 @@
"description": "HTTP 상태 코드"
}
}
},
"AuthRes": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "'Bearer' 토큰으로 사용되는 액세스 토큰"
},
"isRegistered": {
"type": "boolean",
"description": "사용자가 등록되었는지 여부를 나타냅니다"
}
}
}
}
}
Expand Down