API 설계 원칙
REST 및 GraphQL API 설계 원칙을 마스터하여 직관적이고 확장 가능하며 유지보수하기 쉬운 API를 구축하여 개발자를 만족시키고 시간이 지나도 안정적으로 유지하세요.
이 기술을 사용할 때
- 새로운 REST 또는 GraphQL API를 설계할 때
- 기존 API의 사용성을 개선하기 위해 리팩토링할 때
- 팀을 위한 API 설계 표준을 수립할 때
- 구현 전 API 사양을 검토할 때
- API 패러다임 간 전환(REST에서 GraphQL 등)할 때
- 개발자 친화적인 API 문서를 만들 때
- 특정 사용 사례(모바일, 서드파티 통합)에 맞게 API를 최적화할 때
이 기술을 사용하지 말아야 할 때
- 특정 프레임워크에 대한 구현 지침만 필요한 경우
- API 계약 없이 인프라만 작업하는 경우
- 공개 인터페이스를 변경하거나 버전 관리할 수 없는 경우
지침
- 소비자, 사용 사례 및 제약 조건을 정의합니다.
- API 스타일을 선택하고 리소스 또는 타입을 모델링합니다.
- 오류, 버전 관리, 페이지네이션 및 인증 전략을 명시합니다.
- 예제를 통해 검증하고 일관성을 검토합니다.
자세한 패턴, 체크리스트 및 템플릿은 resources/implementation-playbook.md를 참조하세요.
리소스
resources/implementation-playbook.md에서 자세한 패턴, 체크리스트 및 템플릿을 확인할 수 있습니다.