Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
fed45d5
#18 docs: 응원 문구, 포인트 관련 컨트롤러
jongeuni May 27, 2025
ab85450
#18 docs: 목표 생성 컨트롤러
jongeuni May 27, 2025
d7065ae
#18 docs: 목표 생성, 수정, 조회 컨트롤러
jongeuni May 27, 2025
b710f47
#18 fix: Path 수정
jongeuni May 27, 2025
d1d1301
#18 docs: swagger에 token 설정
jongeuni May 27, 2025
5486ce1
refactor: resolve arg에 반환값 설정
jongeuni May 27, 2025
4331bb7
#18 docs: 사용자 정보 애노테이션 스웨거에 노출 안 되도록 추가
jongeuni May 27, 2025
06431eb
#18 docs: 사용자 가입일 조회 유저 컨트롤러에 추가
jongeuni May 27, 2025
4f035d6
#18 docs: 사용자 가입일 조회 path 추가
jongeuni May 27, 2025
c24d7b3
#21 fix: resolve 함수에서 Object -> UUID 넘기도록 수정
jongeuni May 28, 2025
deab0eb
#21 fix: IdRs -> CreateIdRs로 제한
jongeuni May 28, 2025
db934ca
#21 fix: 코드 리뷰 반영 (필드명, 리턴 타입 수정)
jongeuni May 28, 2025
9db7e45
#21 fix: Phrase -> CheerPhrase로 명확화
jongeuni May 28, 2025
0bfff50
#21 refactor: 가입일 조회 URI 변경
jongeuni May 29, 2025
5645ca8
#21 refactor: List null 처리 @ JsonSetter로 변경
jongeuni May 29, 2025
8b6daf2
#21 refactor: Rs 네이밍에 Read 제거
jongeuni May 29, 2025
74f7a71
fix: gradle jar 삭제
jongeuni May 29, 2025
9c1f37b
Merge branch 'refs/heads/main' into feature/goal-docs
jongeuni May 29, 2025
d9241fa
bootjar 아닌 build 사용하도록 변경
jongeuni May 29, 2025
e1c7f76
cache disabled 설정
jongeuni May 29, 2025
345485c
cache disabled 설정 삭제
jongeuni May 29, 2025
f276849
fix: Rs Controller에 반영
jongeuni May 29, 2025
9300e5e
Merge remote-tracking branch 'origin/feature/goal-docs' into feature/…
jongeuni May 29, 2025
763eea7
#18 feat: 더미 데이터 추가
jongeuni May 29, 2025
dde37cd
refactor: isMonthSetting -> isPeriodByMonth
jongeuni May 29, 2025
19f7203
#3 fix: Docker file 수정
jongeuni May 29, 2025
6f1362e
delete: 사용자 가입일 조회 API 삭제
jongeuni May 29, 2025
dd3bb2e
refactor: read -> get 메서드 네이밍 변경 및 컨트롤러 메서드 이름 명확화
jongeuni May 29, 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
16 changes: 15 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,18 @@
build/
**/build/
out/
!api/build/libs/
!api/build/libs/

# Gradle
.gradle

# IDE
.idea
*.iml

# OS
.DS_Store

# Git
.git
.gitignore
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
java-version: '21'
distribution: 'temurin'

- name: Set up Gradle with cache
- name: Set up Gradle cache
uses: gradle/actions/setup-gradle@v4

- name: Build bootJar without tests
- name: Build without tests
run: ./gradlew bootJar -x test

dependency-submission:
Expand Down
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ RUN ls -la /app
FROM openjdk:21-jdk

WORKDIR /app
COPY ./motimo-api/build/libs/motimo-api-*.jar app.jar

COPY --from=builder /app/motimo-api/build/libs/motimo-api-*.jar app.jar
#COPY --from=builder /app/motimo-api/build/libs/motimo-api-*.jar app.jar

EXPOSE 8080

Expand Down
Binary file removed motimo-api/gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
7 changes: 0 additions & 7 deletions motimo-api/gradle/wrapper/gradle-wrapper.properties

This file was deleted.

17 changes: 17 additions & 0 deletions motimo-api/src/main/java/kr/co/api/cheer/CheerController.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package kr.co.api.cheer;

import kr.co.api.cheer.docs.CheerControllerSwagger;
import kr.co.api.cheer.rqrs.CheerPhraseRs;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/v1/cheers")
public class CheerController implements CheerControllerSwagger {

@GetMapping
public CheerPhraseRs getCheerPhrase() {
return new CheerPhraseRs("오늘도 파이팅이에요!");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package kr.co.api.cheer.docs;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import kr.co.api.cheer.rqrs.CheerPhraseRs;

@Tag(name = "응원 API", description = "응원 관련 API 목록입니다")
public interface CheerControllerSwagger {
@Operation(summary = "응원 문구 조회 API", description = "응원 문구를 랜덤 조회합니다.")
CheerPhraseRs getCheerPhrase();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package kr.co.api.cheer.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;

public record CheerPhraseRs(
@Schema(description = "응원 문구", example = "목표는 멀어도 나는 계속 가는중")
String cheerPhrase
) {
}
69 changes: 42 additions & 27 deletions motimo-api/src/main/java/kr/co/api/config/SwaggerConfig.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package kr.co.api.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
Expand All @@ -11,39 +14,51 @@ public class SwaggerConfig {
@Bean
public GroupedOpenApi motimoAPI() {
return GroupedOpenApi
.builder()
.group("Motimo API List")
.addOpenApiCustomizer(
openApi ->
openApi
.setInfo(
new Info()
.title("Motimo API List") // API 제목
.description("모티모 API 목록입니다.") // API 설명
.version("1.0.0") // API 버전
)
)
.build();
.builder()
.group("Motimo API List")
.addOpenApiCustomizer(openApi -> {
jwtSecuritySetting(openApi);
openApi.setInfo(
new Info()
.title("Motimo API List")
.description("모티모 API 목록입니다.")
.version("1.0.0")
);
})
.build();
}



@Bean
public GroupedOpenApi version1() {
return GroupedOpenApi
.builder()
.group("Motimo V1 API List")
.pathsToMatch("/v1/**")
.addOpenApiCustomizer(
openApi ->
openApi
.setInfo(
new Info()
.title("Motimo Version1 API List")
.description("모티모 버전 1 API 목록입니다.")
.version("1.0.0")
)
)
.build();
.builder()
.group("Motimo V1 API List")
.pathsToMatch("/v1/**")
.addOpenApiCustomizer(openApi -> {
jwtSecuritySetting(openApi);
openApi.setInfo(
new Info()
.title("Motimo Version1 API List")
.description("모티모 버전 1 API 목록입니다.")
.version("1.0.0")
);
})
.build();
}


private void jwtSecuritySetting(OpenAPI openApi) {
openApi.getComponents().addSecuritySchemes("BearerAuth",
new SecurityScheme()
.type(SecurityScheme.Type.HTTP)
.scheme("bearer")
.bearerFormat("JWT")
.in(SecurityScheme.In.HEADER)
);

openApi.addSecurityItem(new SecurityRequirement().addList("BearerAuth"));
}

}
38 changes: 38 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/GoalController.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package kr.co.api.goal;

import kr.co.api.goal.docs.GoalControllerSwagger;
import kr.co.api.goal.rqrs.*;
import kr.co.api.security.annotation.AuthUser;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;

@RestController
@RequestMapping("/v1/goals")
public class GoalController implements GoalControllerSwagger {

@ResponseStatus(HttpStatus.CREATED)
@PostMapping
public GoalIdRs createGoal(@RequestBody GoalCreateRq rq) {
return new GoalIdRs(UUID.randomUUID().toString());
}

@PutMapping("/{id}")
public void updateGoal(@PathVariable String id, GoalUpdateRq rq) {
}

@GetMapping
public GoalListRs getGoalList(@AuthUser UUID userId) {
List<GoalItemRs> items = new ArrayList<>();
items.add(new GoalItemRs("첫번째 목표", LocalDate.now(), 50));
items.add(new GoalItemRs("자격증 따기", LocalDate.of(2026, 2, 10), 20));
items.add(new GoalItemRs("노래 만들기", LocalDate.now(), 100));
return new GoalListRs(
items
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package kr.co.api.goal.docs;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import kr.co.api.goal.rqrs.GoalCreateRq;
import kr.co.api.goal.rqrs.GoalIdRs;
import kr.co.api.goal.rqrs.GoalListRs;
import kr.co.api.goal.rqrs.GoalUpdateRq;

import java.util.UUID;

@Tag(name = "목표 API", description = "목표 관련 API 목록입니다")
public interface GoalControllerSwagger {
@Operation(summary = "목표 생성 API", description = "목표를 생성합니다.")
GoalIdRs createGoal(GoalCreateRq rq);

@Operation(summary = "목표 수정 API", description = "목표를 수정합니다.")
void updateGoal(String id, GoalUpdateRq rq);

@Operation(summary = "목표 목록 API", description = "목표 목록을 조회합니다.")
GoalListRs getGoalList(UUID userId);
}
33 changes: 33 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/GoalCreateRq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package kr.co.api.goal.rqrs;

import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

import java.time.LocalDate;
import java.util.List;

public record GoalCreateRq(
@NotNull
@Size(min = 1, max = 20)
@Schema(description = "목표 이름", example = "자격증 따기")
String title,

@NotNull
@Schema(description = "개월 수로 기간 설정 여부")
boolean isPeriodByMonth,

@Size(min = 1, max = 12)
@Schema(description = "목표 개월 수")
Integer month,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

여기서 Integer 사용한 이유는 목표 개월수가 없을수도 있어서 일까요?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

맞습니다...!


@Schema(description = "목표 완료 날짜", format = "date")
LocalDate dueDate,

@Schema(description = "세부 목표 목록")
@JsonSetter(nulls = Nulls.AS_EMPTY)
List<SubGoalCreateRq> subGoals
) {
}
9 changes: 9 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/GoalIdRs.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;

public record GoalIdRs(
@Schema(description = "생성된 아이디")
String id
) {
}
17 changes: 17 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/GoalItemRs.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;

import java.time.LocalDate;

public record GoalItemRs(
@Schema(description = "목표 이름", example = "자격증 따기")
String title,

@Schema(description = "목표 완료 날짜", type = "date")
LocalDate dueDate,

@Schema(description = "목표 달성률 (%)", example = "24.5")
float progress
) {
}
11 changes: 11 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/GoalListRs.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;

import java.util.List;

public record GoalListRs(
@Schema(description = "목표 목록")
List<GoalItemRs> goals
) {
}
30 changes: 30 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/GoalUpdateRq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

public record GoalUpdateRq(
@NotNull
@Size(min = 1, max = 20)
@Schema(description = "목표 이름", example = "자격증 따기")
String title,

@NotNull
@Schema(description = "목표 완료 날짜", format = "date")
LocalDate dueDate,

@Schema(description = "세부 목표 목록")
List<SubGoalUpdateRq> subGoals
) {
public GoalUpdateRq {
if (Objects.isNull(subGoals)) {
subGoals = new ArrayList<>();
}
}
}
17 changes: 17 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/SubGoalCreateRq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public record SubGoalCreateRq(
@NotNull
@Size(min = 1, max = 20)
@Schema(description = "세부 목표 이름", example = "책 한 권 읽기")
String title,

@Size(min = 1, max = 3)
@Schema(description = "세부 목표 중요도 (상: 1, 하:3)")
int importance
) {
}
20 changes: 20 additions & 0 deletions motimo-api/src/main/java/kr/co/api/goal/rqrs/SubGoalUpdateRq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package kr.co.api.goal.rqrs;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public record SubGoalUpdateRq(
@Schema(description = "수정할 세부 목표 아이디")
String id,

@NotNull
@Size(min = 1, max = 20)
@Schema(description = "세부 목표 이름", example = "책 한 권 읽기")
String title,

@Size(min = 1, max = 3)
@Schema(description = "세부 목표 중요도 (상: 1, 하:3)")
int importance
) {
}
Loading