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

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

프롬프트

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

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

댓글 작성

모든 일이 urgent하다는 당신, 그건 착각입니다 업무 배분 프롬프트

최근 직장 동료와 점심을 먹으면서 나눈 대화가 아직도 귀에 맴돌아요. "요즘 너무 바빠서 정신이 없어. 모든 일이 다 급한 ...

상자 밖에서 생각하기: 3-2-1 발상법!

창의적 해결책이 필요한 상황, 누구나 경험해 보셨을 겁니다. 문제가 눈앞에 있지만, 아이디어는 나오지 않고, 마감은 ...

프롬프트

ChatGPT

영감이 찾아오지 않는 순간들

ChatGPT

働きたくなるような職場にするための職場環境改善プロンプト

ChatGPT

회의는 짧게, 성과는 크게!

ChatGPT

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

ChatGPT

나만 이상하게 나와? 지브리로 이쁘게 만드는 방법

ChatGPT

Monitor fair distribution of work prompts

ChatGPT

Prompts to uncover hidden task automation opportunities

ChatGPT

작은 습관이 만드는 부의 연쇄반응

ChatGPT

질문이 답보다 중요한 이유: 사고력 혁명

ChatGPT

전문가처럼 판단하는 기술

ChatGPT

일의 우선순위를 정하면 일 잘한다는 소리 들음..진짜(1000%)

ChatGPT

데이터 홍수 속 진실 찾기 프롬프트

ChatGPT

당신의 업무가 180도 바뀌는 순간

ChatGPT

시간이 부족하다고 느끼신다면?

ChatGPT

버그를 잡기 위한 버그: 테스트 자동화의 숨겨진 비밀

ChatGPT

하루 30분으로 평생 기억하는 학습법!