api 개발 컨벤션에 대한 질문 드립니당

Question

백엔드 개발을 시작한지 얼마 안돼서 확신이 안서는 부분이 있습니다 ㅠㅠ제가 만든 API가 예를 들어 {&#34;data&#34; : 0}을 리턴한다고 가정할게요이거를 웹사이트에서는 0이 아니고 'No' 값으로 출력이 되기를 원하거든요근데 이걸 백엔드에서 굳이 if 0이면, 'No'로 바꿔서 리턴을 해주는 코드가 들어가는 게 맞는건지프론트에서 받아가지고 0 -> 'No'로 출력하는 게 맞는건지 헷갈립니다애초에 백엔드에서는 모든 값들을 다 정리해가지고 프론트는 그냥 맵핑만 시켜주는 게 맞는건가요?

항상청춘 · Answer

api 는 기본적으로 연동가이드와 같은 정의서를 주게되어 있습니다.거기에 결과값에 대한 설명도 기재되어야 하니 사용하는 쪽에서는 맞춰서 사용할거에요.어떤 값을 사용하시든 상관없고 그 값이 무슨 값이지만 명시해주면 됩니다. 0이 더 깔끔하니까 0으로 해야지, 0이 false 인 건 무조건 알겠지? 하고 명시 안 해야지.위와 같은 상황이 문제인 겁니다. 리턴값에 대해 코드 / 코드값 중 더 일반적인 건 경험상 코드일 듯하네요.

CyanGlint · Answer

반환값이 0..n이면 00 or 1이면 true/false요 데이터가 아닌 사용자 이해를 돕기 위한 텍스트는프론트에서 처리하던지 꼭 백에 들어간다면 msg같은 별도 필드를 만드는게 낫지 않을까요

장쭌 · Answer

enum class를 만들어 정의하셔도 되는 것 같습니다.api response로 내려주는 값을 더이상 변조없이 사용한다면, api에서 처리하여 값을 주는 것이 좋다고 생각듭니다. API 에서 response 값을 실어 줄때 enum을 사용하여 0 -> &#34;No&#34; 로 치환하여 값을 주는 방법이 있습니다.

api 개발 컨벤션에 대한 질문 드립니당

3개의 답변

#convention 목록