웹 서비스에서 지원되지 않는 매개 변수

Question

의견을 귀하에게 확인하고 싶습니다.

특정 주소 주변의 특정 국가에있는 할인 프로그램과 관련된 레스토랑 데이터베이스를 검색해야하는 웹 서비스를 디자인해야합니다. 이러한 웹 서비스에 대한 REST 호출은 다음과 같을 것입니다. http://server/search?country=<countryCode>&language=<languageCode>&address=<address>&zipcode=<zipcode>

일부 국가에서는 우편 번호가 없거나 전체 국가에서 사용하지 않는 것이 문제입니다.

사용자가 우편 번호가없는 국가에 대해 이러한 매개 변수를 전달했지만 유효한 주소를 전달하면 어떻게 될까요?

1. 반송 400 잘못된 요청입니다.
2. 간단히 우편 번호 매개 변수를 igonre하고 유효한 주소
3. 반환 특정 형식 (예 : JSON)

일부 동료는 또한 된 우편 번호가 해당 국가에서 지원되지 않습니다 없다는 오류 메시지를 기반으로 결과를 반환 다음 옵션을 선호하십시오. 4. 결과를 단순히 리턴하십시오. zipcode 매개 변수가 지원되지 않는다는 것을 설명서에 명시하십시오. 또한 우리는 어떤 필드가 사용자 인터페이스에 표시되어야 하는지를 반환하는 웹 서비스 메서드를 만들어야합니다.

어떤 옵션이 가장 좋고 왜 그런가요?

감사합니다.

Answer 1

글쎄, 우편 번호를 모르고 어쨌든 결과를 볼 수 있더라도 OpenStreetMap 추천 서버는 결과를 반환합니다. 사용자가 우편 번호를 모르지만 hist 객체를 찾으려면 어떻게해야합니까? 어쨌든 특정 개체를 검색하려고합니다. 일부 국가에서는 우편 번호가 부분적으로 있다고 말했기 때문에 특히 그렇습니다.

사용자가 무엇을 잘못 반환했는지 알 수 없으면 무엇을 해야할지 알 수 없습니다.

Answer 2

이는 사용 사례에 따라 다릅니다. API 사용자가 해당 사례를 실행하는 것이 얼마나 쉬운가요? 사용자가 피하는 방법을 알아야하는 심각한 오류입니까? 또는 사용자가 공식적으로 존재하지 않아야하는 우편 번호를 알 수 있다고 생각할 수있는 곳이 아닌가? API에서 올바른 결과를 검색하는 방법을 사용자가 시행 착오로 내릴 수 있습니까? 그것은 사용자가 그것에 대해 알 필요가 있고 그가 이것을 자신의 편에서 처리해야한다는 잘못된 오류입니까?

API에이 제한을두면 API의 모든 사용자가 해당 설명서를 읽고 이해해야하므로 피할 수 있어야한다는 점을 분명히 밝혀야 할 때이 사례가 명확하게 문서화되어야한다고 생각하십시오. 문제는 사용자가 문제를 피할 수 있어야하며 모든 사용자는이 문제를 피하기 위해 추가 코드를 올바르게 구현해야합니다. 사용자가 우편 번호가있는 지역을 쉽게 알 수 있습니까?

나는 "당신이 받아들이는 것에서 융통성을 지키고, 당신이 출력하는 것"을 엄격하게 생각합니다.