Swagger 구현 (#66)

* build : H2 database 추가 로컬 테스트 용도 * save * build : JWT test secret key 추가 * feat : 인증을 위한 user entity 추가 * feat : jwt 기능 추가 * feat : security config 추가 * feat : 인증 관련 서비스 추가 * feat : 로그인 필터 추가 * delete : 불필요 테스트 클래스 삭제 * fix : 불필요 import 제거, JwtFilter 오류 수정 * feat: 상태값 필드명 수정 * feat: chat 엔티티에 상태 관련 필드 추가 * feat: chart- 인지관리 엔티티 추가 - chart 엔티티와 일대일 연관관계 설정 * feat: 신체 활동 엔티티에서 외출 여부 객체 분리 * feat: 신체 활동 세부 조회 dto 작성 * feat: 신체 활동 세부 조회 dto 생성자 추가 * feat: 간호 관리 세부 조회 dto 생성자 추가 * refactor: chart 관련 response는 별도 패키지로 분리 * feat: 인지 관리 세부 조회 dto 작성 * feat-chart 고나련 엔티티에 comment 추가 * chore: 불필요한 import문 삭제 * feat: 회복 훈련 response dto 작성 * feat: chart detail response dto 작성 * refactor: 도메인 별 패키지 구조로 변경 * feat: chartController 작성 - 환자 id로 일지 전체 조회 함수 구현 * feat: 환자 id로 일지 전체 조회 함수에 pagable 추가 * feat: chartRepository 작성 - 환자 id로 일기 전체 조회 기능 구현 * feat: util 클래스 생성 - default_page_size 선언 * feat: chart 관련 response 전체에 builder 어노테이션 추가 * feat: chart 관련 엔티티 전부에 getter 추가 * chore: 필드명 카멜 케이스로 통일 * feat: ChartDetailResponse 객체 생성 함수 구현 - 세부 항목에 대한 DTO 생성 후 ChartDetailResponse 객체에 넣음 * feat: chartService 작성 - 환자id를 통해 일지 전체 조회 기능 구현 * feat: 차트id로 차트 세부 조회 api 구현 * fix: 차트 특이사항 자료형 변경 - 기존 String에서 TEXT 자료형으로 변경 * 계층 분리, 테이블명을 제외하고 전부 단수형 처리, 간단한 리팩토링 작업 (#24) * feat : 1. 도메인 단위로 계층 분리 2. 테이블명을 제외하고 전부 단수형으로 바꾸기 3. 간단한 리팩토링 * feat : 보호자, 요양보호사 아이디 비번 추가 * refactor : 혜연님 코드 리뷰 전부 반영 * refactor : 혜연님 코드 리뷰 전부 반영 - 2 * refactor : 생성자 오류 해결 * refactor : 코드 리뷰 반영 * feat(security): 권한 Role 추가 * feat : 보호자 회원가입 시 비밀번호 입력+암호화 추가 GuardianService에서 패스워드 암호화를 진행합니다. * feat : SecurityConfig 임시 세팅 추가 관리자 도메인이 없으므로 permit all 로 설정 * test : 보호자 회원가입 + 비밀번호 암호화 테스트 * feat : 보호자 로그인 추가 + 권한 설정 * refactor: 보호자, 요양사 api controller 분리 * feat: 차트 삭제 api 구현 * refactor: reseponse 전체 record 타입으로 변경 * feat: chart request 작성 * feat: 엔티티 mapper 구현 * feat: ChartMapper에 id ignore 옵션 추가 * Revert "feat: ChartMapper에 id ignore 옵션 추가" This reverts commit ae92004. * refactor : 불필요 클래스 삭제 * feat : config jwt 적용된 상태로 수정 * feat : JWT + security userdetails 설정 * feat : 보호자 로그인 기능 추가 * test : 보호자 회원가입 및 로그인 테스트 - swagger * feat : 기존 보호자 도메인 일부 수정 (권한 검사, ID 조회) * refactor : 불필요 필드 삭제 * bug : security 권한 설정 문제 발생 * feat: MapStruct 사용을 위한 getter,setter 추가 * feat: chart 필드 세부 매핑 명시 * test: MapStruct 매핑 확인 테스트 코드 작성 * feat: 사용자에 따른 api prefix 구분 * merge: week4와 merge * feat: 차트 작성 api 구현 * feat: 차트 수정 api 구현 * fix : Role 문제 해결 * feat : 컨트롤러 권한 검사 추가 * feat : 비밀번호 로직 추가 * refactor : 불필요 로그 제거 * feat : 역할에 따른 권한 부여 기능 추가 * feat : 전화번호 조회 명시적 추가 * fix : 불필요 import제거, 포멧팅 * feat : careworker 로그인 권한 허용 * fix : 로그인 스프링 버전으로 변경 * fix : careworker 컨트롤러 권한수정 * fix : appversion 부분 와일드카드 적용 * fix : valid 추가 * fix : bulid 패턴 제거 * fix : careworker 휴대폰 번호 중복 검사 * comment : 개행 조절 * feat : 예외처리 로직 추가 * feat : 토큰 만료 error 추가 * feat : 토큰 만료 검사 추가 * [관리자 페이지] 요양원 도메인 CRUD (#39) * feat: 요양원 도메인 * refactor: admin에서 developer로 변경 * refactor: developer -> admin * refactor: admin->institution 요양원이 관리하는 부분 * feat : 접근권한 관련 커스텀 필터 표현식 추가 그에 맞춰서 BaseUserDetails에 Id와 getRole 메서드 추가 * save : 임시 careworker 저장 * chore : LoginController 통일로 인한 삭제 * chore : root 경로 변경 * build : 설정값 분리 * chore : 요양원 Role 추가 * feat : 로그인 기능 추가 * chore : 불필요 test 삭제 * fix : 잘못된 wildcard 사용 수정 * feat : 로그인 endpoint 통일 custom provider 추가 진행 * chore : 비밀번호 불일치 오류 추가 외 일반적인 개행조절 * fix : 로그인 과정 로그인 불가 문제 해결 @value 어노테이션 앞에 "/" 특수문자가 들어가 있어서 헤더 변환에서 문제가 생긴 것이였음. * chore : 불필요 클래스 삭제 * feat : Principal 내부 InstitutionNumber 추가 * feat : 권환확인 커스텀 어노테이션 추가 * chore : 개행조절, 어노테이션 제거 * chore : merge 문제 해결 * 돌봄대상자/보호자/요양보호사 데이터 파일 입출력 기능 구현 (#49) * feat: 엑셀 정보 처리 (#34) * fix: 형식 반환 수정 (#34) * feat: 시트이름 및 항목 이름 한글로 변경 (#34) * feat: 서비스 로직 분리(#34) * chore : 불필요 주석 삭제 * chore : getter 수정, 개행조절 * chore : 개행조절, 모호한 변수명 변경 * chore : 시크릿키 수정, 이전버전 서비스 제거 * fix: chart 관련 엔티티 cascade 설정 * 차트 작성 오류 수정 (#54) * build : H2 database 추가 로컬 테스트 용도 * save * build : JWT test secret key 추가 * feat : 인증을 위한 user entity 추가 * feat : jwt 기능 추가 * feat : security config 추가 * feat : 인증 관련 서비스 추가 * feat : 로그인 필터 추가 * delete : 불필요 테스트 클래스 삭제 * fix : 불필요 import 제거, JwtFilter 오류 수정 * feat: 상태값 필드명 수정 * feat: chat 엔티티에 상태 관련 필드 추가 * feat: chart- 인지관리 엔티티 추가 - chart 엔티티와 일대일 연관관계 설정 * feat: 신체 활동 엔티티에서 외출 여부 객체 분리 * feat: 신체 활동 세부 조회 dto 작성 * feat: 신체 활동 세부 조회 dto 생성자 추가 * feat: 간호 관리 세부 조회 dto 생성자 추가 * refactor: chart 관련 response는 별도 패키지로 분리 * feat: 인지 관리 세부 조회 dto 작성 * feat-chart 고나련 엔티티에 comment 추가 * chore: 불필요한 import문 삭제 * feat: 회복 훈련 response dto 작성 * feat: chart detail response dto 작성 * refactor: 도메인 별 패키지 구조로 변경 * feat: chartController 작성 - 환자 id로 일지 전체 조회 함수 구현 * feat: 환자 id로 일지 전체 조회 함수에 pagable 추가 * feat: chartRepository 작성 - 환자 id로 일기 전체 조회 기능 구현 * feat: util 클래스 생성 - default_page_size 선언 * feat: chart 관련 response 전체에 builder 어노테이션 추가 * feat: chart 관련 엔티티 전부에 getter 추가 * chore: 필드명 카멜 케이스로 통일 * feat: ChartDetailResponse 객체 생성 함수 구현 - 세부 항목에 대한 DTO 생성 후 ChartDetailResponse 객체에 넣음 * feat: chartService 작성 - 환자id를 통해 일지 전체 조회 기능 구현 * feat: 차트id로 차트 세부 조회 api 구현 * fix: 차트 특이사항 자료형 변경 - 기존 String에서 TEXT 자료형으로 변경 * 계층 분리, 테이블명을 제외하고 전부 단수형 처리, 간단한 리팩토링 작업 (#24) * feat : 1. 도메인 단위로 계층 분리 2. 테이블명을 제외하고 전부 단수형으로 바꾸기 3. 간단한 리팩토링 * feat : 보호자, 요양보호사 아이디 비번 추가 * refactor : 혜연님 코드 리뷰 전부 반영 * refactor : 혜연님 코드 리뷰 전부 반영 - 2 * refactor : 생성자 오류 해결 * refactor : 코드 리뷰 반영 * feat(security): 권한 Role 추가 * feat : 보호자 회원가입 시 비밀번호 입력+암호화 추가 GuardianService에서 패스워드 암호화를 진행합니다. * feat : SecurityConfig 임시 세팅 추가 관리자 도메인이 없으므로 permit all 로 설정 * test : 보호자 회원가입 + 비밀번호 암호화 테스트 * feat : 보호자 로그인 추가 + 권한 설정 * refactor: 보호자, 요양사 api controller 분리 * feat: 차트 삭제 api 구현 * refactor: reseponse 전체 record 타입으로 변경 * feat: chart request 작성 * feat: 엔티티 mapper 구현 * feat: ChartMapper에 id ignore 옵션 추가 * Revert "feat: ChartMapper에 id ignore 옵션 추가" This reverts commit ae92004. * refactor : 불필요 클래스 삭제 * feat : config jwt 적용된 상태로 수정 * feat : JWT + security userdetails 설정 * feat : 보호자 로그인 기능 추가 * test : 보호자 회원가입 및 로그인 테스트 - swagger * feat : 기존 보호자 도메인 일부 수정 (권한 검사, ID 조회) * refactor : 불필요 필드 삭제 * bug : security 권한 설정 문제 발생 * feat: MapStruct 사용을 위한 getter,setter 추가 * feat: chart 필드 세부 매핑 명시 * test: MapStruct 매핑 확인 테스트 코드 작성 * feat: 사용자에 따른 api prefix 구분 * merge: week4와 merge * feat: 차트 작성 api 구현 * feat: 차트 수정 api 구현 * fix : Role 문제 해결 * feat : 컨트롤러 권한 검사 추가 * feat : 비밀번호 로직 추가 * refactor : 불필요 로그 제거 * feat : 역할에 따른 권한 부여 기능 추가 * feat : 전화번호 조회 명시적 추가 * fix : 불필요 import제거, 포멧팅 * feat : careworker 로그인 권한 허용 * fix : 로그인 스프링 버전으로 변경 * fix : careworker 컨트롤러 권한수정 * fix : appversion 부분 와일드카드 적용 * fix : valid 추가 * fix : bulid 패턴 제거 * fix : careworker 휴대폰 번호 중복 검사 * comment : 개행 조절 * feat : 예외처리 로직 추가 * feat : 토큰 만료 error 추가 * feat : 토큰 만료 검사 추가 * feat : 접근권한 관련 커스텀 필터 표현식 추가 그에 맞춰서 BaseUserDetails에 Id와 getRole 메서드 추가 * save : 임시 careworker 저장 * chore : LoginController 통일로 인한 삭제 * chore : root 경로 변경 * build : 설정값 분리 * chore : 요양원 Role 추가 * feat : 로그인 기능 추가 * chore : 불필요 test 삭제 * fix : 잘못된 wildcard 사용 수정 * feat : 로그인 endpoint 통일 custom provider 추가 진행 * chore : 비밀번호 불일치 오류 추가 외 일반적인 개행조절 * fix : 로그인 과정 로그인 불가 문제 해결 @value 어노테이션 앞에 "/" 특수문자가 들어가 있어서 헤더 변환에서 문제가 생긴 것이였음. * chore : 불필요 클래스 삭제 * feat : Principal 내부 InstitutionNumber 추가 * feat : 권환확인 커스텀 어노테이션 추가 * chore : 개행조절, 어노테이션 제거 * chore : merge 문제 해결 * 돌봄대상자/보호자/요양보호사 데이터 파일 입출력 기능 구현 (#49) * feat: 엑셀 정보 처리 (#34) * fix: 형식 반환 수정 (#34) * feat: 시트이름 및 항목 이름 한글로 변경 (#34) * feat: 서비스 로직 분리(#34) * chore : 불필요 주석 삭제 * chore : getter 수정, 개행조절 * chore : 개행조절, 모호한 변수명 변경 * chore : 시크릿키 수정, 이전버전 서비스 제거 * fix: chart 관련 엔티티 cascade 설정 --------- Co-authored-by: mac <[email protected]> Co-authored-by: 김태윤 <[email protected]> Co-authored-by: Jinsol Lee <[email protected]> Co-authored-by: 20jcode <[email protected]> * fix: ChartDetailResponse 변경 - conditionDisease 항목 추가 * chore : Repository 존재확인 메소드명 변경 (#56) * fix: 불필요한 권한 어노테이션 제거 * feat: openai summarization(7일치) * feat: swagger-ui * feat: swagger-ui 빠진 내용 * refactor: Swagger가 아닌, 필요없는 내용 삭제하기 * refactor: Swagger가 아닌, 필요없는 내용 삭제하기 * refactor: Swagger가 아닌, 필요없는 내용 삭제하기 * feat: swagger에 security 추가 --------- Co-authored-by: mac <[email protected]> Co-authored-by: Yoo KyeongMi <[email protected]> Co-authored-by: 김태윤 <[email protected]> Co-authored-by: Jinsol Lee <[email protected]> Co-authored-by: 20jcode <[email protected]> Co-authored-by: Yoo KyeongMi <[email protected]>
kakao-tech-campus-2nd-step3 · Oct 30, 2024 · e79bb5b · e79bb5b
1 parent 1643bca
commit e79bb5b
Show file tree

Hide file tree

Showing 36 changed files with 341 additions and 86 deletions.
diff --git a/build.gradle b/build.gradle
@@ -45,6 +45,9 @@ dependencies {
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
 
+    // SpringDoc OpenAPI (Swagger UI 포함)
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
+
     // 테스트 라이브러리
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'com.h2database:h2' // H2는 테스트 환경에서 주로 사용

diff --git a/src/main/java/dbdr/domain/careworker/controller/CareworkerController.java b/src/main/java/dbdr/domain/careworker/controller/CareworkerController.java
@@ -3,22 +3,20 @@
 import dbdr.domain.careworker.dto.request.CareworkerRequestDTO;
 import dbdr.domain.careworker.dto.response.CareworkerResponseDTO;
 import dbdr.domain.careworker.service.CareworkerService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import java.net.URI;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.DeleteMapping;
-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.PutMapping;
-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 org.springframework.web.bind.annotation.*;
 
+import java.net.URI;
+import java.util.List;
+
+@Tag(name = "[관리자] 요양보호사 (Careworker)", description = "요양보호사 정보 조회, 수정, 삭제, 추가")
 @RestController
 @RequestMapping("/${spring.app.version}/careworker")
 @RequiredArgsConstructor
@@ -29,6 +27,7 @@ public class CareworkerController {
     @Value("${spring.app.version}")
     private String appVersion;
 
+    @Operation(summary = "전체 요양보호사 정보를 특정 요양원아이디로 조회")
     @GetMapping
     public ResponseEntity<List<CareworkerResponseDTO>> getAllCareworkers(
             @RequestParam(value = "institutionId", required = false) Long institutionId) {
@@ -41,13 +40,15 @@ public ResponseEntity<List<CareworkerResponseDTO>> getAllCareworkers(
         return ResponseEntity.ok(careworkerList);
     }
 
+    @Operation(summary = "요양보호사 한 사람의 정보 조회")
     @GetMapping("/{id}")
     public ResponseEntity<CareworkerResponseDTO> getCareworkerById(
-            @PathVariable Long id) {
+        @PathVariable("id") Long id) {
         CareworkerResponseDTO careworker = careworkerService.getCareworkerById(id);
         return ResponseEntity.ok(careworker);
     }
 
+    @Operation(summary = "요양보호사 추가")
     @PostMapping
     public ResponseEntity<CareworkerResponseDTO> createCareworker(
             @Valid @RequestBody CareworkerRequestDTO careworkerDTO) {
@@ -57,16 +58,18 @@ public ResponseEntity<CareworkerResponseDTO> createCareworker(
                 .body(newCareworker);
     }
 
+    @Operation(summary = "요양보호사 정보 수정")
     @PutMapping("/{id}")
-    public ResponseEntity<CareworkerResponseDTO> updateCareworker(@PathVariable Long id,
-                                                                  @Valid @RequestBody CareworkerRequestDTO careworkerDTO) {
+    public ResponseEntity<CareworkerResponseDTO> updateCareworker(@PathVariable("id") Long id,
+        @Valid @RequestBody CareworkerRequestDTO careworkerDTO) {
         CareworkerResponseDTO updatedCareworker = careworkerService.updateCareworker(id,
                 careworkerDTO);
         return ResponseEntity.ok(updatedCareworker);
     }
 
+    @Operation(summary = "요양보호사 삭제")
     @DeleteMapping("/{id}")
-    public ResponseEntity<Void> deleteCareworker(@PathVariable Long id) {
+    public ResponseEntity<Void> deleteCareworker(@PathVariable("id") Long id) {
         careworkerService.deleteCareworker(id);
         return ResponseEntity.noContent().build();
     }

diff --git a/src/main/java/dbdr/domain/careworker/dto/request/CareworkerRequestDTO.java b/src/main/java/dbdr/domain/careworker/dto/request/CareworkerRequestDTO.java
@@ -1,5 +1,6 @@
 package dbdr.domain.careworker.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
@@ -13,16 +14,20 @@
 @AllArgsConstructor
 public class CareworkerRequestDTO {
 
-    @NotNull
+    @Schema(description = "요양기관아이디", example = "1")
+    @NotNull(message = "요양기관 아이디는 필수 항목입니다.")
     private Long institutionId;
 
+    @Schema(description = "요양보호사 이름", example = "박경옥")
     @NotBlank(message = "이름은 필수 항목입니다.")
     private String name;
 
+    @Schema(description = "요양보호사 이메일", example = "[email protected]")
     @NotBlank(message = "이메일은 필수 항목입니다.")
     @Email(message = "올바르지 않은 형식입니다.")
     private String email;
 
+    @Schema(description = "요양보호사 휴대폰 번호", example = "01022223333")
     @NotBlank(message = "휴대폰 번호는 필수 항목입니다.")
     @Pattern(regexp = "010\\d{8}", message = "010XXXXXXXX형식으로 입력해주세요.")
     private String phone;

diff --git a/src/main/java/dbdr/domain/careworker/service/CareworkerService.java b/src/main/java/dbdr/domain/careworker/service/CareworkerService.java
@@ -40,8 +40,8 @@ public CareworkerResponseDTO getCareworkerById(Long id) {
 
     @Transactional
     public CareworkerResponseDTO createCareworker(CareworkerRequestDTO careworkerRequestDTO) {
-        emailExists(careworkerRequestDTO.getEmail());
-        phoneExists(careworkerRequestDTO.getPhone());
+        ensureUniqueEmail(careworkerRequestDTO.getEmail());
+        ensureUniquePhone(careworkerRequestDTO.getPhone());
 
         Careworker careworker = new Careworker(careworkerRequestDTO.getInstitutionId(),
             careworkerRequestDTO.getName(), careworkerRequestDTO.getEmail(),
@@ -53,8 +53,8 @@ public CareworkerResponseDTO createCareworker(CareworkerRequestDTO careworkerReq
     @Transactional
     public CareworkerResponseDTO updateCareworker(Long id,
         CareworkerRequestDTO careworkerRequestDTO) {
-        emailExists(careworkerRequestDTO.getEmail());
-        phoneExists(careworkerRequestDTO.getPhone());
+        ensureUniqueEmail(careworkerRequestDTO.getEmail());
+        ensureUniquePhone(careworkerRequestDTO.getPhone());
 
         Careworker careworker = findCareworkerById(id);
 
@@ -77,13 +77,13 @@ private Careworker findCareworkerById(Long id) {
 
     }
 
-    private void emailExists(String email) {
+    private void ensureUniqueEmail(String email) {
         if (careworkerRepository.existsByEmail(email)) {
             throw new ApplicationException(ApplicationError.DUPLICATE_EMAIL);
         }
     }
 
-    private void phoneExists(String phone) {
+    private void ensureUniquePhone(String phone) {
         if (careworkerRepository.findByPhone(phone).isPresent()) {
             throw new ApplicationException(ApplicationError.DUPLICATE_PHONE);
         }

diff --git a/src/main/java/dbdr/domain/chart/controller/CareWorkerChartController.java b/src/main/java/dbdr/domain/chart/controller/CareWorkerChartController.java
@@ -6,6 +6,8 @@
 import dbdr.domain.chart.dto.response.ChartDetailResponse;
 import dbdr.domain.chart.service.ChartService;
 import dbdr.global.util.api.ApiUtils;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -18,17 +20,20 @@
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
+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;
 
 // 요양사 권한 필요
+@Tag(name = "요양관리사 (Careworker) 차트", description = "요양관리사의 차트 조회, 추가, 수정, 삭제")
 @RestController
 @RequestMapping("/${spring.app.version}/careworker/chart")
 @RequiredArgsConstructor
 public class CareWorkerChartController {
     private final ChartService chartService;
 
+    @Operation(summary = "돌봄대상자 아이디로 차트 정보 조회")
     @GetMapping("/recipient")
     public ResponseEntity<ApiUtils.ApiResult<Page<ChartDetailResponse>>> getAllChartByRecipientId(
             @RequestParam(value = "recipient-id", required = false) Long recipientId,
@@ -38,30 +43,34 @@ public ResponseEntity<ApiUtils.ApiResult<Page<ChartDetailResponse>>> getAllChart
         return ResponseEntity.ok(ApiUtils.success(recipients));
     }
 
+    @Operation(summary = "차트 아이디로 차트 정보 조회")
     @GetMapping("/{chartId}")
-    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> getChartById(@PathVariable Long chartId) {
+    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> getChartById(@PathVariable("chartId") Long chartId) {
         // 환자 정보 접근 권한 확인 로직 필요 -> 요양사가 맡은 환자 정보만 조회 가능
         ChartDetailResponse chart = chartService.getChartById(chartId);
         return ResponseEntity.ok(ApiUtils.success(chart));
     }
 
+    @Operation(summary = "차트 추가")
     @PostMapping
-    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> saveChart(ChartDetailRequest request) {
+    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> saveChart(@RequestBody ChartDetailRequest request) {
         // 환자 정보 접근 권한 확인 로직 필요 -> 요양사가 맡은 환자 정보만 저장 가능
         ChartDetailResponse chart = chartService.saveChart(request);
         return ResponseEntity.status(HttpStatus.CREATED).body(ApiUtils.success(chart));
     }
 
+    @Operation(summary = "차트 아이디로 차트 수정")
     @PutMapping("/{chartId}")
-    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> updateChart(@PathVariable Long chartId,
-                                                                               ChartDetailRequest request) {
+    public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> updateChart(@PathVariable("chartId") Long chartId,
+        @RequestBody ChartDetailRequest request) {
         // 환자 정보 접근 권한 확인 로직 필요 -> 요양사가 맡은 환자 정보만 수정 가능
         ChartDetailResponse chart = chartService.updateChart(chartId, request);
         return ResponseEntity.ok(ApiUtils.success(chart));
     }
 
+    @Operation(summary = "차트 아이디로 차트 삭제")
     @DeleteMapping("/{chartId}")
-    public ResponseEntity<ApiUtils.ApiResult<String>> deleteChart(@PathVariable Long chartId) {
+    public ResponseEntity<ApiUtils.ApiResult<String>> deleteChart(@PathVariable("chartId") Long chartId) {
         // 환자 정보 접근 권한 확인 로직 필요 -> 요양사가 맡은 환자 정보만 삭제 가능
         chartService.deleteChart(chartId);
         return ResponseEntity.status(HttpStatus.NO_CONTENT).build();

diff --git a/src/main/java/dbdr/domain/chart/controller/GuardianChartController.java b/src/main/java/dbdr/domain/chart/controller/GuardianChartController.java
@@ -5,6 +5,8 @@
 import dbdr.domain.chart.dto.response.ChartDetailResponse;
 import dbdr.domain.chart.service.ChartService;
 import dbdr.global.util.api.ApiUtils;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -18,12 +20,14 @@
 import org.springframework.web.bind.annotation.RestController;
 
 // 보호자 권한 필요
+@Tag(name = "보호자 (Guardian) 차트", description = "보호자 차트 조회")
 @RestController
 @RequestMapping("/${spring.app.version}/guardian/chart")
 @RequiredArgsConstructor
 public class GuardianChartController {
     private final ChartService chartService;
 
+    @Operation(summary = "돌봄대상자 아이디로 차트 정보 조회")
     @GetMapping("/recipient")
     public ResponseEntity<ApiUtils.ApiResult<Page<ChartDetailResponse>>> getAllChartByRecipientId(
             @RequestParam(value = "recipient-id", required = false) Long recipientId,
@@ -33,6 +37,7 @@ public ResponseEntity<ApiUtils.ApiResult<Page<ChartDetailResponse>>> getAllChart
         return ResponseEntity.ok(ApiUtils.success(recipients));
     }
 
+    @Operation(summary = "차트 아이디로 차트 정보 조회")
     @GetMapping("/{chartId}")
     public ResponseEntity<ApiUtils.ApiResult<ChartDetailResponse>> getChartById(@PathVariable Long chartId) {
         // 환자 정보 접근 권한 확인 로직 필요 -> 보호자가 자신의 환자 정보만 조회 가능

diff --git a/src/main/java/dbdr/domain/chart/dto/request/BodyManagementRequest.java b/src/main/java/dbdr/domain/chart/dto/request/BodyManagementRequest.java
@@ -1,13 +1,23 @@
 package dbdr.domain.chart.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record BodyManagementRequest(
-        boolean wash, // 세면 유무
-        boolean bath, // 목욕 유무
-        String mealType, // 식사 종류
-        String intakeAmount, // 섭취량
-        int physicalRestroom, // 화장실 횟수
-        boolean has_walked, // 산책
-        boolean has_companion, // 외출 동행
-        String physicalNote // 특이사항 입력
+    @Schema(description = "세면 유무", example = "true")
+    boolean wash, // 세면 유무
+    @Schema(description = "목욕 유무", example = "true")
+    boolean bath, // 목욕 유무
+    @Schema(description = "식사 종류", example = "채식")
+    String mealType, // 식사 종류
+    @Schema(description = "섭취량", example = "3회")
+    String intakeAmount, // 섭취량
+    @Schema(description = "화장실 횟수", example = "6")
+    int physicalRestroom, // 화장실 횟수
+    @Schema(description = "산책", example = "false")
+    boolean has_walked, // 산책
+    @Schema(description = "외출 동행", example = "false")
+    boolean has_companion, // 외출 동행
+    @Schema(description = "특이사항 입력", example = "평소보다 컨디션이 좋으셨다.")
+    String physicalNote // 특이사항 입력
 ) {
 }
diff --git a/src/main/java/dbdr/domain/chart/dto/request/ChartDetailRequest.java b/src/main/java/dbdr/domain/chart/dto/request/ChartDetailRequest.java
@@ -1,13 +1,25 @@
 package dbdr.domain.chart.dto.request;
 
 import dbdr.domain.recipient.entity.Recipient;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 public record ChartDetailRequest(
+	@Schema(description = "상태", example = "오늘은 상태가 매우 좋으셨다.")
 	String conditionDisease,
+	@Schema(description = "돌봄대상자", example = "{\"id\":\"1\"}")
 	Recipient recipient,
+	@Schema(description = "신체활동", example = "{\"wash\": true,\"bath\": true,\"mealType\": \"채식\","
+		+ "\"intakeAmount\": \"3회\",\"physicalRestroom\": 6,\"has_walked\": false,"
+		+ "\"has_companion\": false, \"physicalNote\": \"평소보다 컨디션이 좋으셨다.\"}")
 	BodyManagementRequest bodyManagement,
+	@Schema(description = "간호관리", example = "{\"systolic\": 300,"
+		+ "\"diastolic\": 200,"
+		+ "\"healthTemperature\": \"32도\","
+		+ "\"healthNote\": \"없음\"}")
 	NursingManagementRequest nursingManagement,
+	@Schema(description = "인지관리", example = "{\"cognitiveHelp\": true,\"cognitiveNote\": \"없음\"}")
 	CognitiveManagementRequest cognitiveManagement,
+	@Schema(description = "기능회복훈련", example = "{\"recoveryProgram\":\"회복\",\"recoveryTraining\": true,\"recoveryNote\": \"없음\"}")
 	RecoveryTrainingRequest recoveryTraining
 ) {
 }
diff --git a/src/main/java/dbdr/domain/chart/dto/request/CognitiveManagementRequest.java b/src/main/java/dbdr/domain/chart/dto/request/CognitiveManagementRequest.java
@@ -1,7 +1,11 @@
 package dbdr.domain.chart.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record CognitiveManagementRequest(
-        boolean cognitiveHelp, // 의사소통 도움 여부
-        String cognitiveNote // 인지 관리 특이사항
+    @Schema(description = "의사소통 도움 여부", example = "true")
+    boolean cognitiveHelp, // 의사소통 도움 여부
+    @Schema(description = "인지 관리 특이사항", example = "없음")
+    String cognitiveNote // 인지 관리 특이사항
 ) {
 }
diff --git a/src/main/java/dbdr/domain/chart/dto/request/NursingManagementRequest.java b/src/main/java/dbdr/domain/chart/dto/request/NursingManagementRequest.java
@@ -1,9 +1,15 @@
 package dbdr.domain.chart.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record NursingManagementRequest(
-        int systolic,  // 혈압 최고
-        int diastolic, // 혈압 최저
-        String healthTemperature, // 체온
-        String healthNote // 건강 및 간호관리 특이사항
+    @Schema(description = "혈압 최고", example = "300")
+    int systolic,  // 혈압 최고
+    @Schema(description = "혈압 최저", example = "200")
+    int diastolic, // 혈압 최저
+    @Schema(description = "체온", example = "32도")
+    String healthTemperature, // 체온
+    @Schema(description = "건강 및 간호관리 특이사항", example = "없음")
+    String healthNote // 건강 및 간호관리 특이사항
 ) {
-}
+}
diff --git a/src/main/java/dbdr/domain/chart/dto/request/RecoveryTrainingRequest.java b/src/main/java/dbdr/domain/chart/dto/request/RecoveryTrainingRequest.java
@@ -1,8 +1,13 @@
 package dbdr.domain.chart.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record RecoveryTrainingRequest(
-        String recoveryProgram, // 회복 프로그램 이름
-        boolean recoveryTraining, // 회복훈련 완료 여부
-        String recoveryNote // 회복훈련 특이사항
+    @Schema(description = "회복 프로그램 이름", example = "회복")
+    String recoveryProgram, // 회복 프로그램 이름
+    @Schema(description = "회복훈련 완료 여부", example = "true")
+    boolean recoveryTraining, // 회복훈련 완료 여부
+    @Schema(description = "회복훈련 특이사항", example = "없음")
+    String recoveryNote // 회복훈련 특이사항
 ) {
 }
diff --git a/src/main/java/dbdr/domain/chart/dto/response/BodyManagementResponse.java b/src/main/java/dbdr/domain/chart/dto/response/BodyManagementResponse.java
@@ -1,14 +1,16 @@
 package dbdr.domain.chart.dto.response;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 public record BodyManagementResponse(
-        Long id,
-        boolean wash, // 세면 유무
-        boolean bath, // 목욕 유무
-        String mealType, // 식사 종류
-        String intakeAmount, // 섭취량
-        int physicalRestroom, // 화장실 횟수
-        boolean has_walked, // 산책
-        boolean has_companion, // 외출 동행
-        String physicalNote // 특이사항 입력
+    Long id,
+    @JsonProperty("세면 유무") boolean wash, // 세면 유무
+    @JsonProperty("목욕 유무") boolean bath, // 목욕 유무
+    @JsonProperty("식사 종류") String mealType, // 식사 종류
+    @JsonProperty("섭취량") String intakeAmount, // 섭취량
+    @JsonProperty("화장실 횟수") int physicalRestroom, // 화장실 횟수
+    @JsonProperty("산책 유무") boolean has_walked, // 산책
+    @JsonProperty("외출 동행 유무") boolean has_companion, // 외출 동행
+    @JsonProperty("특이사항 입력") String physicalNote // 특이사항 입력
 ) {
 }