ETC 2

SpringBoot3.x.x Swagger 적용하기

스웨거(Swagger)는 RESTful API를 설계, 빌드, 문서화, 테스트하는 데 사용되는 오픈 소스 프레임워크입니다. 현재는 OpenAPI Specification(OAS)이라는 이름으로 발전했으며, 스웨거는 이 표준을 구현한 가장 널리 사용되는 도구 중 하나입니다.주요 기능:API 문서화: 코드에서 주석이나 설정을 기반으로 API 명세서를 자동으로 생성합니다.Swagger UI: 브라우저 기반의 인터페이스를 제공하여 개발자나 사용자들이 API의 구조를 시각적으로 확인하고 테스트할 수 있도록 합니다.테스트 및 시뮬레이션: API 호출을 시뮬레이션하여 동작을 검증할 수 있습니다.장점:자동 문서화: 개발자의 코드와 문서화를 동기화시켜 API 변경 시 문서도 자동으로 업데이트됩니다.실시간 테스트: Swa..

ETC 2024.11.04

Naming Convention(네이밍 컨벤션)이란

네이밍 컨벤션(Naming Convention)은 코드에서 변수, 함수, 클래스, 파일 등의 이름을 정하는 규칙과 방법을 의미한다. 이 규칙은 코드의 가독성을 높이고 유지보수를 용이하게 하며, 팀 내에서 코드의 일관성을 유지하도록 돕는다. 네이밍 컨벤션은 여러 가지 프로그래밍 언어와 프레임워크에 따라 다를 수 있지만, 기본적인 목표는 코드의 명확성과 일관성을 보장하는 것이다.네이밍 컨벤션의 중요성가독성 향상: 일관된 네이밍 규칙을 사용하면 코드를 읽기 쉽고 이해하기 쉬워진다. 변수나 함수의 이름만 보고도 그 역할을 추측할 수 있다.유지보수 용이: 코드의 일관성을 유지하면, 나중에 코드를 수정하거나 다른 사람이 코드를 이해할 때 유리하다.협업 효율성: 팀 내에서 동일한 네이밍 규칙을 따르면, 코드 리뷰나 ..

ETC 2024.08.19