삽질로그

API 문서 작성 도구 선택 가이드 (Swagger, Redoc 등)

API 문서 작성에 가장 많이 사용되는 도구들을 간단히 비교 정리 주요 API 문서 작성 도구1. Swagger UI특징: OpenAPI 스펙 기반의 대표적인 도구장점: 실시간 테스트 가능, 무료 사용단점: 디자인 커스터마이징 제한2. Redoc특징: 깔끔한 UI와 반응형 디자인장점: 모바일 친화적, 빠른 로딩 속도단점: 테스트 기능 부족3. Postman특징: API 테스트와 문서화 통합 솔루션장점: 팀 협업 기능 강화, 자동 문서 생성단점: 유료 플랜 필요 (고급 기능)4. GitBook특징: 위키 스타일의 문서 작성 플랫폼장점: 직관적인 편집기, 버전 관리단점: API 특화 기능 부족5. Insomnia특징: API 클라이언트 겸 문서화 도구장점: GraphQL 지원 우수단점: 문서 퍼블리싱 기능 ..

주니어 자바 개발자로 일하면서 자주 언급하는 실수들을 정리했다. 1. 변수명과 메서드명이 불명확변수명을 a, b, c나 temp, data 같은 모호한 이름으로 짓는 실수// 나쁜 예: String s = getUserData();// 좋은 예: String userName = getUserData();2. 매직 넘버 사용숫자를 하드코딩해서 나중에 유지보수가 힘들어진다.// 나쁜 예: if (user.getAge() > 19)// 좋은 예: if (user.getAge() >= ADULT_AGE)3. 메서드가 너무 김하나의 메서드에서 너무 많은 일을 처리하려고하는 점. 100줄 넘는 메서드는 읽기도 어렵고 테스트하기도 어렵다. 4. Exception 처리를 대충모든 예외를 Exception으로 잡거나 p..

테스트 커버리지란?정의: 전체 코드 중 테스트가 실행된 코드의 비율측정 단위: 퍼센트(%)로 표현목적: 코드 품질과 안정성 확보적정 테스트 커버리지 수치일반적인 권장사항최소 기준: 70% 이상권장 수준: 80-90%100%는 현실적이지 않음 (비용 대비 효과 낮음)프로젝트별 기준금융/의료 시스템: 90% 이상일반 웹 애플리케이션: 80% 정도스타트업/MVP: 60-70%커버리지 유형별 이해Line Coverage (라인 커버리지)public class Calculator { public int divide(int a, int b) { if (b == 0) { throw new IllegalArgumentException("Division by zero"); // 이 ..

단위 테스트란?가장 작은 단위의 코드를 테스트보통 하나의 메서드나 클래스를 테스트외부 의존성을 Mock으로 대체빠르고 독립적TDD의 기본통합 테스트란?여러 컴포넌트가 함께 동작하는지 테스트실제 DB, API 등 외부 시스템과 연동단위 테스트보다 느림실제 환경과 비슷한 조건에서 테스트주요 차이점구분 단위 테스트 통합 테스트범위개별 메서드/클래스여러 컴포넌트속도빠름느림외부 의존성Mock 사용실제 시스템 사용격리성완전 격리부분 격리복잡도단순복잡Java 단위 테스트 예제테스트 대상 클래스public class Calculator { public int add(int a, int b) { return a + b; } public int divide(int a, int b) { ..

Redis를 공부하면서 정리한 실제 사용 상황들을 정리해보았다.1. 캐싱이 필요할 때데이터베이스 부하를 줄이고 싶다면 Redis를 사용 자주 조회되는 데이터를 메모리에 저장응답 속도 10배 이상 빨라짐예: 상품 정보, 사용자 프로필 등2. 세션 관리가 필요할 때로그인 상태를 여러 서버에서 공유해야 한다면 Redis를 사용하는 것이 좋다 사용자 로그인 정보를 중앙에서 관리서버가 여러 대여도 세션 유지 가능자동 만료 설정으로 보안성 확보3. 실시간 기능을 구현할 때즉시 반응해야 하는 기능들실시간 채팅 메시지 저장게임 순위표 업데이트알림 큐 관리온라인 사용자 수 카운팅4. 임시 데이터 저장이 필요할 때잠깐 저장했다가 사라져도 되는 데이터들이메일 인증 코드 (5분 후 만료)장바구니 임시 저장API 호출 제한 카..