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

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

프롬프트

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

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

댓글 작성

숨겨진 버그를 찾아내는 개발자의 비밀 무기!

문제의 징후는 미묘했습니다. 애플리케이션이 특정 조건에서만 간헐적으로 충돌했고, 로그 파일은 아무런 단서도 제공하지 않...

오픈소스, 함께 만드는 성장의 무대

처음 오픈소스 프로젝트에 참여할 때, 많은 분들이 이런 고민을 하곤 합니다. "내가 과연 도움이 될 수 있을까?", "코드가 엉...

개발

공지

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

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

공유

사용자 중심 인터페이스 프롬프트

공유

서버리스 아키텍처 혁신 프롬프트

공유

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

공유

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

공유

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

공유

함수형 사고로 바꾸는 코드 리팩토링 프롬프트

공유

AI 추천의 비밀! 주제별 맞춤 추천 엔진 구축 프롬프트

공유

코드를 깔끔하게 개선은 하지만, 성능은 유지하는

공유

업무자동화 스크립트 프롬프트

공유

코드 분석 프롬프트

공유

탄탄한 소프트웨어, 설계의 비밀 프롬프트

공유

오래된 코드를 활용하는 프롬프트

공유

변수 헷갈림 방지 프롬프트! vba 변수 선언 자동화!

공유

사용자 100명에서 100만명으로, 서버가 견뎌낸 기적

공유

새벽 4시 버그와의 전쟁에서 승리하는 법

공유

코드 리뷰가 개발팀을 살렸다