### 달력이 기록을 공유할 때, 달록 🌙
[
](https://dallog.me) [
](https://dallog.github.io) [
](https://github.com/woowacourse-teams/2022-dallog/releases/tag/v1.1.6)
[](https://dallog.me)
## 🌙 소개
달록은 우아한테크코스 공유 캘린더입니다. 우아한테크코스 공식 일정, 데일리 팀, 스터디 등 파편화된 여러 일정을 모아 달록에서 관리할 수 있습니다. 사용자는 관심있는 일정 카테고리를 구독하여 개인화된 캘린더를 사용할 수 있습니다.
**[달록을 더 자세히 알아보고 싶다면, 여기로!](https://sites.google.com/woowahan.com/woowacourse-demo-4th/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8/%EB%8B%AC%EB%A1%9D)**
## 🖥 서비스 화면
## 🛠 Tech Stacks
### Front-end
### Back-end
## ⚙️ Infrastructure
## 🔀 CI/CD Pipeline
## 🌈 알록달록하게 일을 더 잘하는 9가지 방법
## 👥 Members
| Backend | Backend | Backend | Backend | Frontend | Frontend |
| :------------------------------------------: | :------------------------------------------------: | :----------------------------------------------: | :------------------------------------------: | :--------------------------------------------: | :-----------------------------------------: |
|  |  |  |  |  |  |
| [매트(최기현)](https://github.com/hyeonic) | [리버(구동희)](https://github.com/gudonghee2000) | [파랑(이하은)](https://github.com/summerlunaa) | [후디(조동현)](https://github.com/devHudi) | [티거(이다예)](https://github.com/daaaayeah) | [나인(장호영)](https://github.com/jhy979) |
================================================
FILE: backend/.gitignore
================================================
HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/
### resources ###
/src/main/resources/static/docs
### logs ###
logs/
================================================
FILE: backend/build.gradle
================================================
plugins {
id 'org.springframework.boot' version '2.7.1'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'org.asciidoctor.jvm.convert' version '3.3.2'
id 'org.sonarqube' version '3.3'
id 'java'
id 'jacoco'
}
group = 'com.allog'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
ext {
snippetsDir = file('build/generated-snippets')
}
configurations {
asciidoctorExtensions
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
implementation 'org.springframework.boot:spring-boot-starter-validation'
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-cache'
runtimeOnly 'mysql:mysql-connector-java'
runtimeOnly 'com.h2database:h2'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'io.rest-assured:rest-assured:4.4.0'
// JWT를 위한 의존성
implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
// Restdocs를 위한 의존성
asciidoctorExtensions 'org.springframework.restdocs:spring-restdocs-asciidoctor'
testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
// Sonarqube를 위한 의존성
implementation 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:3.3'
}
test {
outputs.dir snippetsDir
useJUnitPlatform()
finalizedBy 'jacocoTestReport'
}
jacoco {
toolVersion = "0.8.8"
}
jacocoTestReport {
reports {
xml.enabled true
csv.enabled true
html.enabled true
xml.destination file("${buildDir}/jacoco/index.xml")
csv.destination file("${buildDir}/jacoco/index.csv")
html.destination file("${buildDir}/jacoco/index.html")
}
afterEvaluate {
classDirectories.setFrom(
files(classDirectories.files.collect {
fileTree(dir: it, excludes: [
'**/*Application*',
'**/*Exception*',
'**/dto/**',
'**/infrastructure/**',
'**/global/config/**',
'**/BaseEntity*',
'**/ControllerAdvice*',
'**/AuthorizationExtractor*'
])
})
)
}
finalizedBy 'jacocoTestCoverageVerification'
}
jacocoTestCoverageVerification {
violationRules {
rule {
enabled = true
element = "CLASS"
// 모든 클래스 각각 라인 커버리지 75% 만족시 빌드 성공
limit {
counter = 'LINE'
value = 'COVEREDRATIO'
minimum = 0.75
}
excludes = [
'*.*Application',
'*.*Exception',
'*.dto.*',
'*.infrastructure.*',
'*.global.config.*',
'*.BaseEntity',
'*.ControllerAdvice',
'*.AuthorizationExtractor'
]
}
}
}
sonarqube {
properties {
property 'sonar.projectKey', 'dallog'
property "sonar.sources", "src"
property "sonar.language", "java"
property "sonar.sourceEncoding", "UTF-8"
property "sonar.profile", "Dallog Custom Java Ruleset"
property "sonar.java.binaries", "${buildDir}/classes"
property "sonar.test.inclusions", "**/*Test.java"
property 'sonar.exclusions', '**/jacoco/**'
property 'sonar.coverage.exclusions', '**/test/**/*, **/*Application*, **/global/config/**, **/dto/**, **/*Exception*, **/infrastructure/**, **/BaseEntity*, **/ControllerAdvice*, **/AuthorizationExtractor*'
property "sonar.coverage.jacoco.xmlReportPaths", "${buildDir}/jacoco/index.xml"
}
}
asciidoctor {
configurations 'asciidoctorExtensions'
baseDirFollowsSourceFile()
inputs.dir snippetsDir
dependsOn test
}
asciidoctor.doFirst {
delete file('src/main/resources/static/docs')
}
task copyDocument(type: Copy) {
dependsOn asciidoctor
from "${asciidoctor.outputDir}"
into file("src/main/resources/static/docs")
}
bootJar {
dependsOn copyDocument
}
================================================
FILE: backend/gradle/wrapper/gradle-wrapper.properties
================================================
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
================================================
FILE: backend/gradlew
================================================
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"
================================================
FILE: backend/gradlew.bat
================================================
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
================================================
FILE: backend/src/docs/asciidoc/auth.adoc
================================================
== Auth(인증)
=== OAuth 로그인 링크 생성
==== HTTP Request
include::{snippets}/auth/generateLink/http-request.adoc[]
==== Path Parameters
include::{snippets}/auth/generateLink/path-parameters.adoc[]
==== Request Parameters
include::{snippets}/auth/generateLink/request-parameters.adoc[]
==== HTTP Response
include::{snippets}/auth/generateLink/http-response.adoc[]
==== Response Fields
include::{snippets}/auth/generateLink/response-fields.adoc[]
=== OAuth 로그인
==== HTTP Request
include::{snippets}/auth/generateTokens/http-request.adoc[]
==== Path Parameters
include::{snippets}/auth/generateTokens/path-parameters.adoc[]
==== Request Fields
include::{snippets}/auth/generateTokens/request-fields.adoc[]
==== HTTP Response
include::{snippets}/auth/generateTokens/http-response.adoc[]
==== Response Fields
include::{snippets}/auth/generateTokens/response-fields.adoc[]
=== OAuth 로그인 (Resource Server 에러)
==== HTTP Response
include::{snippets}/auth/generateTokens/failByResourceServerError/http-response.adoc[]
=== RefreshToken을 통한 자동 로그인
==== HTTP Request
include::{snippets}/auth/generateRenewalToken/http-request.adoc[]
==== Request Fields
include::{snippets}/auth/generateRenewalToken/request-fields.adoc[]
==== HTTP Response
include::{snippets}/auth/generateRenewalToken/http-response.adoc[]
==== Response Fields
include::{snippets}/auth/generateRenewalToken/response-fields.adoc[]
=== RefreshToken을 통한 자동 로그인 (Invalid Token 에러)
==== HTTP Response
include::{snippets}/auth/generateRenewalToken/invalidTokenError/http-response.adoc[]
================================================
FILE: backend/src/docs/asciidoc/category.adoc
================================================
== Category(카테고리)
=== 카테고리 생성
==== HTTP Request
include::{snippets}/category/save/http-request.adoc[]
==== Request Fields
include::{snippets}/category/save/request-fields.adoc[]
==== HTTP Response
include::{snippets}/category/save/http-response.adoc[]
==== Response Fields
include::{snippets}/category/save/response-fields.adoc[]
=== 카테고리 생성 (유효하지 않은 카테고리 이름)
==== HTTP Response
include::{snippets}/category/save/failByInvalidNameFormat/http-response.adoc[]
=== 전체 카테고리 조회
==== Request
include::{snippets}/category/findAllByName/allByNoName/http-request.adoc[]
==== HTTP Response
include::{snippets}/category/findAllByName/allByNoName/http-response.adoc[]
=== 전체 카테고리 목록 이름으로 필터링
==== HTTP Request
include::{snippets}/category/findAllByName/filterByName/http-request.adoc[]
==== Request Parameters
include::{snippets}/category/findAllByName/filterByName/request-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/findAllByName/filterByName/http-response.adoc[]
=== 자신이 일정을 추가/수정/삭제할 수 있는 카테고리 목록 조회
==== HTTP Request
include::{snippets}/category/findScheduleEditableCategories/http-request.adoc[]
==== HTTP Response
include::{snippets}/category/findScheduleEditableCategories/http-response.adoc[]
=== 자신이 ADMIN으로 있는 카테고리 목록 조회
==== HTTP Request
include::{snippets}/category/findAdminCategories/http-request.adoc[]
==== HTTP Response
include::{snippets}/category/findAdminCategories/http-response.adoc[]
=== ID를 통한 카테고리 단건 조회
==== HTTP Request
include::{snippets}/category/findDetailCategoryById/http-request.adoc[]
==== Path Parameters
include::{snippets}/category/findDetailCategoryById/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/findDetailCategoryById/http-response.adoc[]
=== ID를 통한 카테고리 단건 조회 (존재하지 않는 경우)
==== HTTP Response
include::{snippets}/category/findDetailCategoryById/failByNoCategory/http-response.adoc[]
=== 카테고리 수정
==== HTTP Request
include::{snippets}/category/update/http-request.adoc[]
==== Path Parameters
include::{snippets}/category/update/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/update/http-response.adoc[]
=== 카테고리 수정 (존재하지 않는 경우)
==== HTTP Response
include::{snippets}/category/update/failByNoCategory/http-response.adoc[]
=== 카테고리 수정 (유효하지 않은 카테고리 이름)
==== HTTP Response
include::{snippets}/category/update/failByInvalidNameFormat/http-response.adoc[]
=== 카테고리 삭제
==== HTTP Request
include::{snippets}/category/delete/http-request.adoc[]
==== Path Parameters
include::{snippets}/category/delete/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/delete/http-response.adoc[]
=== 카테고리 삭제 (존재하지 않는 경우)
==== HTTP Response
include::{snippets}/category/delete/failByNoCategory/http-response.adoc[]
=== 카테고리 역할 수정
역할이 ADMIN인 회원은 카테고리 구독자(일반 구독자, 관리자, 자기자신 모두 포함)의 역할을 수정할 수 있습니다.
==== HTTP Request
include::{snippets}/category/updateRole/http-request.adoc[]
==== Path Parameters
include::{snippets}/category/updateRole/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/updateRole/http-response.adoc[]
=== 카테고리 역할 수정 (권한이 없는 경우)
역할이 ADMIN인 경우만 구독자의 역할을 수정할 수 있습니다.
==== HTTP Response
include::{snippets}/category/updateRole/failByNoPermission/http-response.adoc[]
=== 카테고리 역할 수정 (구독을 하지 않은 경우)
카테고리 역할 수정 대상의 회원이 해당 카테고리를 구독하지 않은 상태인경우 역할 또한 존재하지 않으므로 역할을 찾을 수 없습니다.
==== HTTP Response
include::{snippets}/category/updateRole/failByCategoryRoleNotFound/http-response.adoc[]
=== 카테고리 역할 수정 (자신의 역할 수정시, 자신이 유일한 ADMIN인 경우)
자기자신의 카테고리 역할 수정시 자신이 해당 카테고리의 유일한 ADMIN인 경우 역할을 변경할 수 없습니다.
==== HTTP Response
include::{snippets}/category/updateRole/failBySoleAdmin/http-response.adoc[]
=== 카테고리 구독자 목록 조회
==== Request
include::{snippets}/category/findSubscribers/http-request.adoc[]
==== Path Parameters
include::{snippets}/category/findSubscribers/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/category/findSubscribers/http-response.adoc[]
=== 카테고리 구독자 목록 조회 (호출자가 ADMIN이 아닌 경우)
==== HTTP Response
include::{snippets}/category/findSubscribers/failByNoAuthority/http-response.adoc[]
================================================
FILE: backend/src/docs/asciidoc/external-calendar.adoc
================================================
== External Calendar (외부 캘린더)
=== 자신의 외부 캘린더 조회
==== HTTP Request
include::{snippets}/externalCalendar/get/http-request.adoc[]
==== HTTP Response
include::{snippets}/externalCalendar/get/http-response.adoc[]
=== 자신의 외부 캘린더 저장
==== HTTP Request
include::{snippets}/externalCalendar/save/http-request.adoc[]
==== Request Fields
include::{snippets}/externalCalendar/save/request-fields.adoc[]
==== HTTP Response
include::{snippets}/externalCalendar/save/http-response.adoc[]
=== 자신의 외부 캘린더 저장 (중복 저장할 경우)
==== HTTP Response
include::{snippets}/externalCalendar/duplicated-save/http-response.adoc[]
================================================
FILE: backend/src/docs/asciidoc/index.adoc
================================================
= 달록 API 문서
:doctype: book
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 3
include::auth.adoc[]
include::member.adoc[]
include::category.adoc[]
include::schedule.adoc[]
include::subscription.adoc[]
include::external-calendar.adoc[]
================================================
FILE: backend/src/docs/asciidoc/member.adoc
================================================
== Member(회원)
=== 내 정보 조회
==== HTTP Request
include::{snippets}/member/findMe/http-request.adoc[]
==== HTTP Response
include::{snippets}/member/findMe/http-response.adoc[]
==== Response Fields
include::{snippets}/member/findMe/response-fields.adoc[]
=== 내 정보 조회 (존재하지 않는 회원 조회 시)
==== HTTP Response
include::{snippets}/member/findMe/failNoMember/http-response.adoc[]
=== 내 정보 수정
==== HTTP Request
include::{snippets}/member/update/http-request.adoc[]
==== Request Fields
include::{snippets}/member/update/request-fields.adoc[]
==== HTTP Response
include::{snippets}/member/update/http-response.adoc[]
================================================
FILE: backend/src/docs/asciidoc/schedule.adoc
================================================
== Schedule(일정)
=== 회원 일정 목록 조회
==== HTTP Request
include::{snippets}/schedule/findSchedulesByMemberId/http-request.adoc[]
==== Request Parameters
include::{snippets}/schedule/findSchedulesByMemberId/request-parameters.adoc[]
==== HTTP Response
include::{snippets}/schedule/findSchedulesByMemberId/http-response.adoc[]
=== 카테고리 별 일정 목록 조회
==== HTTP Request
include::{snippets}/schedule/findSchedulesByCategoryId/http-request.adoc[]
==== Request Parameters
include::{snippets}/schedule/findSchedulesByCategoryId/request-parameters.adoc[]
==== HTTP Response
include::{snippets}/schedule/findSchedulesByCategoryId/http-response.adoc[]
=== 일정 등록
==== HTTP Request
include::{snippets}/schedule/save/http-request.adoc[]
==== HTTP Response
include::{snippets}/schedule/save/http-response.adoc[]
=== 일정 등록 (카테고리 권한이 없을 때)
==== HTTP Response
include::{snippets}/schedule/save/failByNoPermission/http-response.adoc[]
=== 일정 생성 (카테고리가 존재하지 않음)
==== HTTP Response
include::{snippets}/schedule/save/failByNoCategory/http-response.adoc[]
=== 일정 단건 조회
==== HTTP Request
include::{snippets}/schedule/findById/http-request.adoc[]
==== HTTP Response
include::{snippets}/schedule/findById/http-response.adoc[]
=== 일정 단건 조회 (일정이 존재하지 않을 때)
==== HTTP Response
include::{snippets}/schedule/findById/failByNoSchedule/http-response.adoc[]
=== 일정 수정
==== HTTP Request
include::{snippets}/schedule/update/http-request.adoc[]
==== Path Parameters
include::{snippets}/schedule/update/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/schedule/update/http-response.adoc[]
=== 일정 수정 (카테고리 권한이 없을 때)
==== HTTP Response
include::{snippets}/schedule/update/failByNoPermission/http-response.adoc[]
=== 일정 수정 (카테고리가 존재하지 않을 때)
==== HTTP Response
include::{snippets}/schedule/update/failByNoSchedule/http-response.adoc[]
=== 일정 제거
==== HTTP Request
include::{snippets}/schedule/delete/http-request.adoc[]
==== Path Parameters
include::{snippets}/schedule/delete/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/schedule/delete/http-response.adoc[]
=== 일정 제거 (카테고리 권한이 없을 때)
==== HTTP Response
include::{snippets}/schedule/delete/failByNoPermission/http-response.adoc[]
=== 일정 제거 (카테고리가 존재하지 않음)
==== HTTP Response
include::{snippets}/schedule/delete/failByNoSchedule/http-response.adoc[]
================================================
FILE: backend/src/docs/asciidoc/subscription.adoc
================================================
== Subscription(구독)
=== 구독 등록
==== HTTP Request
include::{snippets}/subscription/save/http-request.adoc[]
==== Path Parameters
include::{snippets}/subscription/save/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/subscription/save/http-response.adoc[]
=== 구독 등록 (중복된 구독을 등록할 때)
==== HTTP Response
include::{snippets}/subscription/save/failByAlreadyExisting/http-response.adoc[]
=== 구독 등록 (3자의 개인 카테고리 구독 요청시)
==== HTTP Response
include::{snippets}/subscription/save/failBySubscribingPrivateCategoryOfOther/http-response.adoc[]
=== 자신의 구독 목록 조회
==== HTTP Request
include::{snippets}/subscription/findMine/http-request.adoc[]
==== HTTP Response
include::{snippets}/subscription/findMine/http-response.adoc[]
=== 내 구독 정보 수정
==== HTTP Request
include::{snippets}/subscription/update/http-request.adoc[]
==== Path Parameters
include::{snippets}/subscription/update/path-parameters.adoc[]
==== Request Headers
include::{snippets}/subscription/update/request-headers.adoc[]
==== Request Parameters
include::{snippets}/subscription/update/request-body.adoc[]
==== HTTP Response
include::{snippets}/subscription/update/http-response.adoc[]
=== 구독 삭제
==== HTTP Request
include::{snippets}/subscription/delete/http-request.adoc[]
==== Path Parameters
include::{snippets}/subscription/delete/path-parameters.adoc[]
==== HTTP Response
include::{snippets}/subscription/delete/http-response.adoc[]
=== 구독 삭제 (내 구독이 아닐 때)
==== HTTP Response
include::{snippets}/subscription/delete/failByNoPermission/http-response.adoc[]
================================================
FILE: backend/src/main/java/com/allog/dallog/DallogApplication.java
================================================
package com.allog.dallog;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DallogApplication {
public static void main(String[] args) {
SpringApplication.run(DallogApplication.class, args);
}
}
================================================
FILE: backend/src/main/java/com/allog/dallog/auth/application/AuthService.java
================================================
package com.allog.dallog.auth.application;
import com.allog.dallog.auth.domain.AuthToken;
import com.allog.dallog.auth.domain.OAuthToken;
import com.allog.dallog.auth.domain.OAuthTokenRepository;
import com.allog.dallog.auth.dto.OAuthMember;
import com.allog.dallog.auth.dto.request.TokenRenewalRequest;
import com.allog.dallog.auth.dto.response.AccessAndRefreshTokenResponse;
import com.allog.dallog.auth.dto.response.AccessTokenResponse;
import com.allog.dallog.auth.event.MemberSavedEvent;
import com.allog.dallog.member.domain.Member;
import com.allog.dallog.member.domain.MemberRepository;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Transactional(readOnly = true)
@Service
public class AuthService {
private final MemberRepository memberRepository;
private final OAuthTokenRepository oAuthTokenRepository;
private final TokenCreator tokenCreator;
private final ApplicationEventPublisher eventPublisher;
public AuthService(final MemberRepository memberRepository, final OAuthTokenRepository oAuthTokenRepository,
final TokenCreator tokenCreator, final ApplicationEventPublisher eventPublisher) {
this.memberRepository = memberRepository;
this.oAuthTokenRepository = oAuthTokenRepository;
this.tokenCreator = tokenCreator;
this.eventPublisher = eventPublisher;
}
@Transactional
public AccessAndRefreshTokenResponse generateAccessAndRefreshToken(final OAuthMember oAuthMember) {
Member foundMember = findMember(oAuthMember);
OAuthToken oAuthToken = getOAuthToken(oAuthMember, foundMember);
oAuthToken.change(oAuthMember.getRefreshToken());
AuthToken authToken = tokenCreator.createAuthToken(foundMember.getId());
return new AccessAndRefreshTokenResponse(authToken.getAccessToken(), authToken.getRefreshToken());
}
private Member findMember(final OAuthMember oAuthMember) {
String email = oAuthMember.getEmail();
if (memberRepository.existsByEmail(email)) {
return memberRepository.getByEmail(email);
}
return saveMember(oAuthMember);
}
private Member saveMember(final OAuthMember oAuthMember) {
Member savedMember = memberRepository.save(oAuthMember.toMember());
eventPublisher.publishEvent(new MemberSavedEvent(savedMember.getId()));
return savedMember;
}
private OAuthToken getOAuthToken(final OAuthMember oAuthMember, final Member member) {
Long memberId = member.getId();
if (oAuthTokenRepository.existsByMemberId(memberId)) {
return oAuthTokenRepository.getByMemberId(memberId);
}
return oAuthTokenRepository.save(new OAuthToken(member, oAuthMember.getRefreshToken()));
}
public AccessTokenResponse generateAccessToken(final TokenRenewalRequest tokenRenewalRequest) {
String refreshToken = tokenRenewalRequest.getRefreshToken();
AuthToken authToken = tokenCreator.renewAuthToken(refreshToken);
return new AccessTokenResponse(authToken.getAccessToken());
}
public Long extractMemberId(final String accessToken) {
Long memberId = tokenCreator.extractPayload(accessToken);
memberRepository.validateExistsById(memberId);
return memberId;
}
}
================================================
FILE: backend/src/main/java/com/allog/dallog/auth/application/AuthTokenCreator.java
================================================
package com.allog.dallog.auth.application;
import com.allog.dallog.auth.domain.AuthToken;
import com.allog.dallog.auth.domain.TokenRepository;
import org.springframework.stereotype.Component;
@Component
public class AuthTokenCreator implements TokenCreator {
private final TokenProvider tokenProvider;
private final TokenRepository tokenRepository;
public AuthTokenCreator(final TokenProvider tokenProvider, final TokenRepository tokenRepository) {
this.tokenProvider = tokenProvider;
this.tokenRepository = tokenRepository;
}
public AuthToken createAuthToken(final Long memberId) {
String accessToken = tokenProvider.createAccessToken(String.valueOf(memberId));
String refreshToken = createRefreshToken(memberId);
return new AuthToken(accessToken, refreshToken);
}
private String createRefreshToken(final Long memberId) {
if (tokenRepository.exist(memberId)) {
return tokenRepository.getToken(memberId);
}
String refreshToken = tokenProvider.createRefreshToken(String.valueOf(memberId));
return tokenRepository.save(memberId, refreshToken);
}
public AuthToken renewAuthToken(final String refreshToken) {
tokenProvider.validateToken(refreshToken);
Long memberId = Long.valueOf(tokenProvider.getPayload(refreshToken));
String accessTokenForRenew = tokenProvider.createAccessToken(String.valueOf(memberId));
String refreshTokenForRenew = tokenRepository.getToken(memberId);
AuthToken renewalAuthToken = new AuthToken(accessTokenForRenew, refreshTokenForRenew);
renewalAuthToken.validateHasSameRefreshToken(refreshToken);
return renewalAuthToken;
}
public Long extractPayload(final String accessToken) {
tokenProvider.validateToken(accessToken);
return Long.valueOf(tokenProvider.getPayload(accessToken));
}
}
================================================
FILE: backend/src/main/java/com/allog/dallog/auth/application/JwtTokenProvider.java
================================================
package com.allog.dallog.auth.application;
import com.allog.dallog.auth.exception.InvalidTokenException;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jws;
import io.jsonwebtoken.JwtException;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import io.jsonwebtoken.security.Keys;
import java.nio.charset.StandardCharsets;
import java.util.Date;
import javax.crypto.SecretKey;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class JwtTokenProvider implements TokenProvider {
private final SecretKey key;
private final long accessTokenValidityInMilliseconds;
private final long refreshTokenValidityInMilliseconds;
public JwtTokenProvider(@Value("${security.jwt.token.secret-key}") final String secretKey,
@Value("${security.jwt.token.access.expire-length}") final long accessTokenValidityInMilliseconds,
@Value("${security.jwt.token.refresh.expire-length}") final long refreshTokenValidityInMilliseconds) {
this.key = Keys.hmacShaKeyFor(secretKey.getBytes(StandardCharsets.UTF_8));
this.accessTokenValidityInMilliseconds = accessTokenValidityInMilliseconds;
this.refreshTokenValidityInMilliseconds = refreshTokenValidityInMilliseconds;
}
@Override
public String createAccessToken(final String payload) {
return createToken(payload, accessTokenValidityInMilliseconds);
}
@Override
public String createRefreshToken(final String payload) {
return createToken(payload, refreshTokenValidityInMilliseconds);
}
private String createToken(final String payload, final Long validityInMilliseconds) {
Date now = new Date();
Date validity = new Date(now.getTime() + validityInMilliseconds);
return Jwts.builder()
.setSubject(payload)
.setIssuedAt(now)
.setExpiration(validity)
.signWith(key, SignatureAlgorithm.HS256)
.compact();
}
@Override
public String getPayload(final String token) {
return Jwts.parserBuilder()
.setSigningKey(key)
.build()
.parseClaimsJws(token)
.getBody()
.getSubject();
}
@Override
public void validateToken(final String token) {
try {
Jws