Merge pull request #21 from Nexters/dev

Dev

Author: Jeongminyooa

build.gradle

@@ -33,6 +33,7 @@ dependencies {
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4'
 }
 
 tasks.named('test') {

src/main/java/donmani/donmani_server/DonmaniController.java

@@ -0,0 +1,24 @@
+package donmani.donmani_server.common.config;
+
+import org.springframework.context.annotation.Bean;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+
+public class OpenAPIConfig {
+	/**
+	 * OpenAPI bean 구성
+	 * @return
+	 */
+	@Bean
+	public OpenAPI openAPI() {
+		Info info = new Info()
+			.title("swagger 테스트")
+			.version("1.0")
+			.description("API에 대한 설명 부분");
+		return new OpenAPI()
+			.components(new Components())
+			.info(info);
+	}
+}

src/main/java/donmani/donmani_server/common/config/OpenAPIConfig.java

@@ -0,0 +1,33 @@
+// Use DBML to define your database structure
+// Docs: https://dbml.dbdiagram.io/docs
+
+Table Expense {
+  id bigint [primary key]
+  user_id bigint
+  created_at timestamp
+  category category_type
+  flag flag_type
+  memo string
+}
+
+Table User {
+  id bigint [primary key]
+  user_key string
+  name string
+  level int
+}
+
+Enum category_type {
+  created
+  running
+  done
+  failure
+}
+
+Enum flag_type {
+  GOOD
+  BAD
+  NO
+}
+
+Ref: Expense.user_id > User.id // many-to-one

src/main/java/donmani/donmani_server/common/log/LogController.java

@@ -0,0 +1,37 @@
+package donmani.donmani_server.expense.controller;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import donmani.donmani_server.expense.dto.ExpenseRequestDTO;
+import donmani.donmani_server.expense.dto.ExpenseResponseDTO;
+import donmani.donmani_server.expense.service.ExpenseService;
+import lombok.RequiredArgsConstructor;
+
+@RestController
+@RequestMapping("/expenses")
+@RequiredArgsConstructor
+public class ExpenseController {
+	private final ExpenseService expenseService;
+
+	@GetMapping("/{userKey}")
+	public ResponseEntity<ExpenseResponseDTO> getExpenses(
+		@PathVariable String userKey,
+		@RequestParam int year,
+		@RequestParam int month) {
+		ExpenseResponseDTO response = expenseService.getExpenses(userKey, year, month);
+		return ResponseEntity.ok(response);
+	}
+
+	@PostMapping
+	public ResponseEntity<Void> addExpense(@RequestBody ExpenseRequestDTO request) {
+		expenseService.addExpense(request);
+		return ResponseEntity.ok().build();
+	}
+}

src/main/java/donmani/donmani_server/common/sql/20250201.sql

@@ -0,0 +1,25 @@
+package donmani.donmani_server.expense.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import donmani.donmani_server.expense.entity.CategoryType;
+import donmani.donmani_server.expense.entity.FlagType;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Getter
+@Setter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL) // null 값 제외
+public class ContentDTO {
+	private FlagType flag;
+	private CategoryType category;
+	private String memo;
+}
+

src/main/java/donmani/donmani_server/expense/controller/ExpenseController.java

@@ -0,0 +1,24 @@
+package donmani.donmani_server.expense.dto;
+
+import java.util.List;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotEmpty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Getter
+@Setter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+public class ExpenseRequestDTO {
+	@NotBlank(message = "Device ID가 존재하지 않습니다.")
+	private String userKey;
+
+	@NotEmpty(message = "소비 기록이 입력되지 않았습니다.")
+	private List<RecordDTO> records;
+}

src/main/java/donmani/donmani_server/expense/dto/ContentDTO.java

@@ -0,0 +1,19 @@
+package donmani.donmani_server.expense.dto;
+
+import java.util.List;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Getter
+@Setter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+public class ExpenseResponseDTO {
+	private String userKey;
+	private List<RecordDTO> records;
+}

src/main/java/donmani/donmani_server/expense/dto/ExpenseRequestDTO.java

@@ -0,0 +1,23 @@
+package donmani.donmani_server.expense.dto;
+
+import java.time.LocalDate;
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Getter
+@Setter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL) // null 값 제외
+public class RecordDTO {
+	private LocalDate date;
+	private List<ContentDTO> contents; // null 가능
+}