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

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

프롬프트

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

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

댓글 작성

한 서버가 다운되자 전체 서비스가 마비된 그날

올해 블랙프라이데이 세일 때 일어난 일이에요. 평소보다 10배 많은 트래픽이 몰리면서 메인 서버 하나가 과부하로 다운됐는...

언제 터질지 모를 레거시 코드

매일 새로운 기능을 추가할 때마다 다른 곳에서 버그가 발생하는 악몽 같은 상황을 겪어보셨나요? 한 개발자는 10년 된 레거...

개발

공지

📢[필독] GPT 프롬프트 커뮤니티 이용 가이드

📢[필독] GPT 프롬프트 커뮤니티 이용 가이드

공유

1초 지연이 매출 손실로 이어지는 시대가 왔다

공유

또 같은 코드를 복붙하고 있는 나를 발견했다면?

공유

서비스가 서비스를 못 찾는다고?

공유

서버 설정도 코드처럼? 인프라 코드화 혁명!

공유

시스템 건강상태 실시간 체크 프롬프트

공유

안전한 레거시 시스템 탈출 프롬프트

공유

시스템을 지키는 서킷 브레이커 설계 프롬프트

공유

시스템 생명 신호 관리 프롬프트

공유

완벽한 롤백 전략 설계 프롬프트

공유

서비스 중단 없는 배포 전략 프롬프트

공유

복잡한 연결의 마술사 프롬프트

공유

보안 위협을 막아내는 방패 프롬프트

공유

분산트랜잭션, 개발자의 딜레마를 해결하는 전략 프롬프트

공유

데이터 정합성 해결사 프롬프트

공유

서버 지휘자 마스터 프롬프트

공유

서비스 미로 탈출 프롬프트