API 자원 명명 규칙 기록부
첨부된 "양식 파일" 다운로드 링크는 아래로 내리시면 연관(관련)된 서식 목록 아래 쪽에 있습니다.
개발 과정에서 일관된 명명 방식을 확립하고 통합 관리하기 위해 필요한 기술 문서로 프로젝트 전반의 자원 규칙을 기록 관리하며 개발 표준성을 높이는 서식으로 리소스명, 메서드, 엔드포인트, 매개변수, 상태코드, 응답본문으로 이루어져 있습니다.
API 자원 주요항목
작성시 고려사항
API 자원 주요항목
- 리소스명: 명확하고 일관된 명명 규칙을 적용하여 개발자 간 이해를 높이는 기준을 제시합니다.
- 메서드: 표준화된 프로토콜과 호출 방식에 대한 상세한 지침을 정립하고 통일성을 확보합니다.
- 엔드포인트: 시스템 간 상호작용을 위한 정확하고 논리적인 접근 경로를 정의하는 규칙을 수립합니다.
- 설명: 각 자원과 기능에 대한 명확하고 간결한 설명 방식을 규정하여 이해도를 향상시킵니다.
- 매개변수: 데이터 전송을 위한 표준화된 파라미터 정의 및 사용 규칙을 체계적으로 관리합니다.
- 응답코드: 다양한 상황에 대응하는 표준 상태코드 및 응답 형식을 일관되게 정의합니다.
- 필드타입: 데이터 구조와 타입에 대한 명확한 지침을 제공하여 데이터 일관성을 확보합니다.
작성시 고려사항
- 명명규칙: 개발 팀 내에서 합의된 명명 기준을 엄격히 준수하고 일관성을 유지해야 합니다.
- 가독성: 복잡한 기술용어보다는 직관적이고 이해하기 쉬운 용어를 선택해야 합니다.
- 확장성: 미래 기술 변화와 시스템 성장을 고려한 유연한 명명 방식을 채택해야 합니다.
- 문서화: 모든 명명 규칙과 예외사항을 상세히 문서화하여 팀원 간 공유해야 합니다.
첨부파일