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

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

프롬프트

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

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

댓글 쓰기

    레거시 코드의 숨겨진 보물: 기술 부채를 자산으로 바꾸는 연금술

    "이 코드는 도대체 누가 작성한 거지?" 하고 한숨 쉬다가 커밋 기록을 확인해보니 작성자가 6개월 전의 자기 자신이었던 경험...

    코드의 숨겨진 함정: 디버깅 시간을 반으로 줄이는 비밀

    결과부터 말씀드리겠습니다. 지난달 3주가 걸릴 것으로 예상했던 프로젝트 디버깅을 단 9일 만에 완료했습니다. 많은 개발자...

    기술

    공지

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

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

    공유

    코드의 숨겨진 미학을 발견하다

    공유

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

    공유

    로그인 방식이 달라도 결국은 하나의 계정인듯

    공유

    로그인 인증 설계, 하루 잡아먹었는데 GPT 덕분에 퇴근이 빨라졌어요

    공유

    Next.js + Prisma로 이메일 인증 기능 구현하는 법

    공유

    비밀번호 재설정도, GPT가 설계부터 같이 해줘요

    공유

    구글 로그인, 직접 안 짜도 되는 프롬프트 모음

    공유

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

    공유

    엑셀 VBA 마스터하기: 반복 작업을 코드로 해방시키는 여정

    공유

    연결의 예술에서 비즈니스 가치까지

    공유

    사용자를 사로잡는 웹사이트의 보이지 않는 법칙

    공유

    레거시 코드의 숨겨진 보물: 기술 부채를 자산으로 바꾸는 연금술

    공유

    사용자가 눈치채지 못하는 디자인이 최고의 디자인이다

    공유

    오픈소스가 세상을 바꾸는 방식

    공유

    AI 개발자의 숨겨진 책임

    공유

    대규모 시스템을 구축하는 비밀