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

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

프롬프트

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

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

댓글 작성

로그인 계속 유지되게 하고 싶을 때, 이렇게 물어봐요

Next.js 프로젝트에서 사용자 로그인 상태를 유지하는 기능, 처음부터 직접 짜려면 은근히 복잡하잖아요. JWT를 활용하면서도...

리팩토링의 중요

여러분은 느린 프로그램 때문에 답답함을 느껴본 적 있으신가요? 개발 현장에서는 종종 코드가 복잡해지고, 성능이 점점...

개발

공지

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

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

공유

코드 최적화의 5가지 비밀

공유

테스트 자동화, 정말 개발 효율을 높일 수 있을까요?

공유

무엇이 진짜 버그인가

공유

버그, 혼자서만 고칠 필요 있을까요?

공유

코드 리뷰, 성장의 비밀 통로일까?

공유

숨겨진 버그, 체계적 접근

공유

나도 이제는 데이터 분석!! 전문가?

공유

서버 에러 발생 시 해결 방안 찾는 지피티 프롬프

공유

코드 구조 잡는 데만 반나절 걸리던 개발 업무 GPT로 30분 컷

공유

반복 작업으로 날 새던 파이썬 스크립트 GPT로 10분 컷

공유

API 응답 처리도 프롬프트 하나로

공유

개발할 때 cursor 커서 사용했는데 너무 편합니다. 자동 개발 시작.

공유

이메일 인증 기능도 그냥 GPT한테 맡겨