Skip to content

feat: [이승주] .env 설정 및 Swagger 문서화 (closes #30) - #33

Open
SeungJu0 wants to merge 1 commit into
developfrom
feat/30-swagger
Open

SeungJu0 wants to merge 1 commit into
developfrom
feat/30-swagger

Conversation

@SeungJu0

Copy link
Copy Markdown

개요

.env로 민감 정보를 분리하고, application.yml/application-local.yml로 프로필을 구성했습니다. 또한 Swagger(SpringDoc OpenAPI 3)로 BookController API를 문서화하고, 실제 MySQL 연동까지 확인했습니다.

작업 내용

  • MySQL 설치 및 backend14th DB 생성
  • .env 파일 생성 및 .gitignore 등록
  • application.yml: spring.config.import로 .env 자동 로드, profiles.active 설정
  • application-local.yml: local 프로필 전용 DB 설정 분리
  • SpringDoc 의존성 추가 및 SwaggerConfig 설정
  • Book 엔티티, Repository, Controller 작성 (GET /books/{id}, POST /books)
  • Swagger 어노테이션 적용 (@tag, @operation, @parameter, @apiresponse)
  • Swagger UI에서 API 호출 후 MySQL에 실제 저장되는지 확인

관련 이슈

closes #30

리뷰 포인트

  • .env 관련 파일이 실수로 커밋되지 않았는지 확인해 주세요
  • 프로필 분리 구조(application.yml / application-local.yml)가 올바른지 확인해 주세요
  • Swagger 어노테이션이 올바르게 적용됐는지 확인해 주세요
  • Book 데이터가 실제로 DB에 저장/조회되는지 확인해 주세요
스크린샷 2026-09-19 215853 스크린샷 2026-09-19 220138

@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 181d4228-dc80-407d-be77-869d7e6b1617


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: .env 설정 및 Swagger 문서화

1 participant