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

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

프롬프트

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

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

댓글 작성

전문가처럼 판단하는 기술

중요한 결정 앞에서 망설이고 있나요? 수많은 데이터와 변수 속에서 어떤 선택이 최선인지 판단하기 어려운 상황은 업무 현장...

데이터에서 이야기를 발견하는 법

방대한 양의 데이터를 보유하고 있지만 실질적인 인사이트를 얻지 못해 좌절하신 적이 있으신가요? 한 마케팅 매니저는 수개...

프롬프트

공지

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

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

ChatGPT

당신의 돈이 당신을 위해 일하게 하는 법

ChatGPT

감정의 파도를 붓끝에 담다

ChatGPT

코인 차트 분석 프롬프트 (피드백 요청까지)

ChatGPT

투자의 숨은 진실: 감정은 버리고, 데이터를 따르라!

ChatGPT

생각의 연결고리, 옵시디언으로 마스터하기

ChatGPT

읽히는 블로그의 비밀

ChatGPT

현명한 공부, 10배 빠른 성장

ChatGPT

매일 10분만 투자했더니 TOEIC RC가 쉬워짐..

ChatGPT

✨ 일상의 마법사: 평범한 아이디어를 혁신으로 변환하는 법

ChatGPT

“우리 브랜드, 대체 누구세요?” 흐릿했던 얼굴, 이젠 빛나는 매력으로!

ChatGPT

시간을 지배하는 당신, 오늘의 우선순위는 무엇인가요?

ChatGPT

OTP 인증, 진짜 서비스에 붙일 땐 이렇게 짰습니다

ChatGPT

GPT로 사주 본 적 있으세요? 직접 해보니 놀랍더라고요

ChatGPT

마음을 움직이는 붓질 프롬프트

ChatGPT

지금 시작하는 30년 후 자유: 은퇴 설계의 숨은 공식

ChatGPT

회의 시간을 반으로 줄이는 마법의 방법