[Swagger 초기 적용]

This commit is contained in:
2025-08-13 13:53:15 +09:00
parent 74f8b65327
commit e0e868a282
4 changed files with 67 additions and 1 deletions

View File

@@ -8,6 +8,7 @@
- **Security**: Spring Security + JWT
- **Build Tool**: Gradle
- **Container**: Docker + Kubernetes
- **API Documentation**: Swagger (SpringDoc OpenAPI)
## 개발 가이드
@@ -31,7 +32,30 @@ src/main/java/com/bio/bio_backend/
└── BioBackendApplication.java
```
### 2. 트랜잭션 관리
### 2. API 문서화 (Swagger)
#### Swagger UI 접속
- **URL**: `http://localhost:8080/service/swagger-ui.html`
- **API Docs**: `http://localhost:8080/service/api-docs`
#### 주요 어노테이션
```java
@Tag(name = "Member", description = "회원 관리 API")
@Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "회원 가입 성공"),
@ApiResponse(responseCode = "400", description = "잘못된 요청 데이터")
})
```
#### 설정 파일
- **SwaggerConfig.java**: OpenAPI 기본 정보 설정
- **application.properties**: Swagger UI 커스터마이징
### 3. 트랜잭션 관리
#### 기본 설정