견고성 원칙 및 API

Question

Robustness Principle () 당신이하는 일에 보수를 지키고, 다른 사람들로부터 받아 들일 수있는 자유로운 마음으로을 API에 적용해야합니까? 예를 들어

, 나는 두 가지 방법 중 하나를 사용자 매개 변수를 처리하는 API와 같은 제한를 본 적이 :

제한 사용자 경우, 결과의 최대 수를 반환하는 것입니다

한계 인에 'x'문자가 입력되면 일부 API는 입력 값이 아니기 때문에 유효성 검사 오류가 발생하고 다른 API는 기본 제한값 (예 : 1000)으로 돌아갑니다.

이러한 사용자 입력을 처리하는 방법에 대해 무엇을 권하고 싶습니까? 유용하고 설명적인 검증 오류를 던지거나 입력을 정상적으로 삭제하고 요청을 계속 진행할 수 있습니까?

Answer 1

당신이 할 일을 명확하게 문서화하는 한 큰 차이가 없습니다. 이와 같은 상황에서의 귀하의 행동은 특정 분야와 유형의 데이터에 크게 의존합니다. 예를 들어 숫자 값은 1000과 같은 숫자로 기본값을 설정할 수 있지만 잘못된 타임 스탬프로 무엇을 할 것인가?

한계 값의 경우 기본값이 없어도 (모든 값이 포함되지 않은 경우 사용할 수 있음) API가 각 필드에 대해 작동하는 방식을 명확하게 문서화해야합니다 (기본값, 기본값 값 등). 명확하게 문서화되어 있다면 사용자는 어느 방향 으로든 올바르게 사용할 수 있어야합니다.