견고한 API를 설계하는 최적의 전략

댓글주술사
2,002
10 0
복잡한 시스템을 개발하다 보면 API 설계가 전체 프로젝트의 성패를 좌우한다는 사실을 깨닫게 됩니다. 많은 개발자들이 초기 설계 단계에서 충분한 고민 없이 API를 구축하고, 나중에 확장성 문제, 불일치한 응답 형식, 취약한 오류 처리 등으로 고통받습니다.

프롬프트

복사
---기본 정보---
* 프로젝트 유형: [웹/모바일/IoT/마이크로서비스 등]
* 예상 트래픽 규모: [초당 요청 수/사용자 수]
* 기술 스택: [언어/프레임워크/데이터베이스]
* 주요 기능: [핵심 기능 3-5개]
---데이터 모델링---
* 핵심 엔티티:
- [엔티티1]: [주요 속성]
- [엔티티2]: [주요 속성]
* 관계:
- [엔티티1] <-> [엔티티2]: [관계 유형]
---API 요구사항---
* 엔드포인트 그룹화:
- [리소스1]
- [리소스2]
* 인증/권한:
- [인증 방식]
- [권한 수준]
* 특별 고려사항:
- [성능/보안/규제 요건]
---설계 요청---
1. RESTful 리소스 설계
2. 엔드포인트 정의 (경로/메서드/매개변수)
3. 응답 구조 및 상태 코드
4. 오류 처리 전략
5. 페이지네이션/필터링/정렬 메커니즘
6. 버전 관리 및 확장 전략
7. API 문서화 예시

위 정보를 바탕으로 견고하고 확장 가능한 API 설계를 제안해주세요.
실제 코드 예시와 함께 각 결정의 이론적 근거를 설명해주시면 좋겠습니다.
메타인지적으로 바로 동비할 수 있도록 설계해주세요.
코드는 코드블럭에 담아주세요.

댓글 작성

재택근무 효율을 200% 끌어올린 나만의 프롬프트 기술

직장인이라면 누구나 경험하는 재택근무의 양면성! 편안함 속에 숨어있는 업무 집중력 저하와 소통 단절은 어느새 큰 스트레...

뻔한 아이디어 탈출 프롬프트

혹시 여러분도 "참신한 아이디어가 떠오르지 않아"라고 고민해본 적 있으신가요?우리 회사 기획팀에서 신제품 아이디어 회의...

프롬프트

ChatGPT

쪼개서 살린 시스템 분리 프롬프트

ChatGPT

슬랙 하나로 팀워크가 달라졌습니다(커뮤니케이션을 잘하려면 이 커뮤니케이션 도구 프롬프트!)

ChatGPT

“질문이 수업을 바꾼다, 정말일까요?”

ChatGPT

물리적 한계를 뛰어넘는 메타버스 갤러리 프롬프트

ChatGPT

인플레이션 시대를 견디는 가계경제 방어 프롬프트

ChatGPT

학습 거부감을 흥미로 바꾸는 심리적 접근 프롬프트

ChatGPT

레거시 애플리케이션을 컨테이너로 전환하는 마이그레이션 프롬프트

ChatGPT

침묵하는 조직을 말하게 만드는 문화개선 프롬프트

ChatGPT

현실과 가상을 넘나드는 AR 아트 체험 프롬프트

ChatGPT

잠자는 교실을 깨우는 수업 혁신 프롬프트

ChatGPT

비상시에도 흔들리지 않는 현금 포트폴리오 프롬프트

ChatGPT

서버 응답속도 10배 향상시키는 백엔드 최적화 프롬프트

ChatGPT

한 번에 전달되는 업무 메일 작성 프롬프트

ChatGPT

학습자 맞춤형 교육 시스템 아키텍처 프롬프트

ChatGPT

가계부 도중 포기하지 않는 동기부여 프롬프트

ChatGPT

서로 다른 예술 장르를 결합하는 크로스오버 창작 프롬프트