Agent skill · software engineering · aiskillstore
allra-api-design
Allra 백엔드 API 설계 및 패키지 구조 규칙. Use when creating REST APIs, DTOs, or organizing backend code structure.
Why this skill is useful
Defines specific API design patterns and DTO naming conventions that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Allra Backend API 설계 및 패키지 구조 Allra 백엔드 팀의 API 설계, DTO 네이밍, 패키지 구조 표준을 정의합니다. 프로젝트 기본 정보 이 가이드는 다음 환경을 기준으로 작성되었습니다: Java: 17 이상 Spring Boot: 3.2 이상 주요 기술: JPA/Hibernate, QueryDSL, JWT 참고: 프로젝트별로 사용하는 기술 스택이나 버전이 다를 수 있습니다. 프로젝트에 맞게 조정하여 사용하세요. 패키지 구조 규칙 도메인별 패키지 구조를 권장합니다: 참고: 프로젝트에 따라 controller, model, dao 등 다른 이름을 사용할 수 있습니다. 중요한 것은 레이어별 책임을 명확히 분리하는 것입니다. 예시 DTO 네이밍 규칙 1. 클라이언트 통신 DTO Request: {Operation}Request 예: SignUpRequest, UpdateUserRequest Response: {Operation}Response 예: SignUpResponse, UserDetailResponse 2. 내부 사용 DTO 내부에서만 사용하는 DTO는 Dto 접미사 추가: Repository Layer QueryDSL Fetch DTO Internal Layer Transfer DTO 예: UserSignUpEventDto, UserSummaryDto 3. Record 사용 DTO 같은 단순 클래스들은 가능하면 대부분 record로 생성 API 컨트롤러 설계 가이드 1. REST API 명명 규칙 참고: API 버저닝(/api/v1/...)은 프로젝트 정책에 따라 선택적으로 적용합니다. 2. Request Validation 모든 Request DTO는 Bean Validation 사용: 3. 응답 형식 Allra 표준 형식 (예시): 성공 응답: 에러 응답: 참고: 응답 형식은 프로젝트별로 다를 수 있습니다. 일관성 있는 형식을 유지하는 것이 중요합니다. When to Use This Skill 이 skill은 다음 상황에서 자동으로 적용됩니다: 새로운 API 엔드포인트 생성 DTO 클래스 작성 컨트롤러 구현 도메인 패키지 구조 설계 Request/Response 객체 네이밍 Examples 예제 1: 새로운 도메인 API 생성 예제 2: 내부 DTO 생성 Checklist 새로운 API를 만들 때 확인사항: [ ] 도메인별 패키지 구조를 따르는가? [ ] Request/Response DTO 네이밍이 규칙을 따르는가? [ ] DTO가 record로 작성되었는가? [ ] Request DTO에 Validation이 적용되었는가? [ ] REST API 명명 규칙을 따르는가? [ ] 내부 사용 DTO에 Dto 접미사가 있는가?
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/allra-api-design